Repository files navigation

Oengus is a web application that helps manage speedrun marathons

https://oengus.io

Note that the front-end lives on this repositoryhttps://github.com/esamarathon/oengus-webapp.

Disclaimer: self-hosted instances are not allowed to use the Oengus branding.

• Java JDK 17
• PostgreSQL 10+

A docker image is hosted on docker hubhttps://hub.docker.com/repository/docker/oengusio/backend

On PostgreSQL, create a database namedoengus

Fill the following fields and add them to your environment variables, this can be done locally with your favourite IDE but we strongly recommend Intellij IDEA. For Discord/Twitch, only one of them is required so you can login. We recommend usingDiscord since it's the easiest to setup.

The redirect urls for this are:

• Login: [base_url]/login/discord
• Sync: [base_url]/user/settings/sync/discord

Alternatively you can just use username/password login

AMQP_URI=amqp://localhost/;AMQP_USERNAME=guest;AMQP_PASSWORD= guest;JWT_SECRET=<random string>;PAYPAL_CLIENT_ID=; //Unrequired if you don't work on donationsPAYPAL_CLIENT_SECRET=; //Unrequired if you don't work on donationsDISCORD_CLIENT_ID=;DISCORD_CLIENT_SECRET=;DISCORD_BOT_TOKEN=;TWITCH_CLIENT_ID=;TWITCH_CLIENT_SECRET=;DB_URL=jdbc:postgresql://localhost:5432/oengus;DB_USERNAME=;DB_PASSWORD=;BASE_URL=http://localhost:4200;OAUTH_ORIGINS=http://localhost:4200,https://oengus.io;SENTRY_DSN=;SENTRY_TRACES_SAMPLE_RATE=1.0;SENTRY_ENVIRONMENT=local;

./gradlew dependencies

Docker setup instructions are indocs/DOCKER.md.

1. Copydocker-compose.yml todocker-compose.override.yml
2. Fill in the environment variables indocker-compose.override.yml
3. Rundocker-compose up --build

StartOengusApplication.java with your favourite IDE. On first startup the database will be initialized automatically.Seedocs/DEVELOPER.md for detailed instructions on how to set up a development environment.

Please join the officialDiscord server for questions and support

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate (if tests exist).

This project uses weblate for its translations, you can contribute by visitinghttps://hosted.weblate.org/projects/oengusio/exports

GNU AGPL v3.0