Tournament Tracker

The one-stop shop for all official osu! tournament correspondence and information!

Development

Prerequisites

• Node v18+
• MongoDB
• Cloudflare R2 Object Storage bucket for storing uploaded files (optional)
• yarn
• an osu! API v2 client

Setup

• Clone the repository
• Set up a MongoDB database
• Set up a Cloudflare R2 bucket (optional)
• Run yarn
• Set up config.json from config.example.json with the following fields:
  • connection: MongoDB connection string
  • session: session string, can be anything
  • baseUrl: base URL of the website
  • automation: boolean for whether to run automation jobs or not
  • osuApp: credentials for the osu! API v2 client
  • osuBot: credentials for the osu! bot API client
  • discord: Discord webhook setup
  • r2: the Cloudflare R2 bucket's credentials (optional)
• Set up checklist.json from checklist.example.json
• Run yarn dev, the project will be served in http://localhost:8088
• If you need automation jobs to run when the project starts, use yarn dev-automation instead

Commit message flags

This is purely for self-documentation purposes.

• --skip-deploy: Skip the deployment of the project to production
• --skip-client-refresh: Skip the client refresh notification

References

• DeepWiki Overview

API

This project has a few public API endpoints, feel free to use them within reasonable limits.

• GET /api/tournaments — queries the tournament listing
• GET /api/tournaments/:id — gets a specific tournament via its ID
• GET /api/votes — queries the public votes listing
• GET /api/votes/:id — gets a specific public vote via its ID
• GET /api/tickets — queries the tickets listing
• GET /api/tickets/:id — gets a specific ticket via its ID

Again, please use these with moderation. If you need other API functionalities (i.e. more routes, websockets, etc.), contact me and we'll figure something out.