Observatory is a powerful "on demand" beatmap manager which uses osu! API and popular beatmap mirrors to prioritize speed and efficiency. It fetches beatmaps from the API's, and stores them in a local database for faster access.
- Plug and Use: Just compile the docker image and run it. No need to worry about dependencies.
- Don't fret about rate limits: Rate limits are handled by the application, so peppy or beatmap mirror's owners won't get angry at you.
- Fastest wins the race: The application is designed to prioritize the fastest API's first to provide the best experience.
- Long and reliable memory: The application saves the data in database to avoid unnecessary API calls, also including TTL (time-to-live) for the data to be reliable.
- Everyone loves caching: We also have a caching layer between the requests and our database, which allows processing requests blazingly fast.
- Perfomance Points calculation: If you're frequently calculating pp, you can use the
/calculatorendpoint, which utilizes rosu-pp-js to compute pp, star rating and other related data.
-
Fill the
.envfile with the required data -
Run the following command:
docker compose -f docker-compose.yml up -d # Creates the container with app and all dependencies- The application will be available at
http://localhost:3333
- Clone the repository
- Install the required dependencies:
bun install - Fill the
.envfile with the required data - Start needed services:
bun run setup - Run the application:
bun run dev - The application will be available at
http://localhost:3333(or any other port you set up to)
If you want to contribute to the project, feel free to fork the repository and submit a pull request. We are open to any suggestions and improvements.
This project is licensed under the MIT License. See the LICENSE file for more details.