The one-stop shop for all official osu! tournament correspondence and information!
- Node v18+
- MongoDB
- Cloudflare R2 Object Storage bucket for storing uploaded files (optional)
- yarn
- an osu! API v2 client
- Clone the repository
- Set up a MongoDB database
- Set up a Cloudflare R2 bucket (optional)
- Run
yarn - Set up
config.jsonfromconfig.example.jsonwith the following fields:connection: MongoDB connection stringsession: session string, can be anythingbaseUrl: base URL of the websiteautomation: boolean for whether to run automation jobs or notosuApp: credentials for the osu! API v2 clientosuBot: credentials for the osu! bot API clientdiscord: Discord webhook setupr2: the Cloudflare R2 bucket's credentials (optional)
- Run
yarn dev, the project will be served inhttp://localhost:8088 - If you need automation jobs to run when the project starts, use
yarn dev-automationinstead