https://github.com/sunrisecommunity/observatory

🔭 Observatory - Powerful beatmap manager for osu!
https://github.com/sunrisecommunity/observatory

beatmap-downloader beatmap-mirror bun drizzle-orm elysiajs manager osu osugame

Last synced: about 1 month ago
JSON representation

🔭 Observatory - Powerful beatmap manager for osu!

• Host: GitHub
• URL: https://github.com/sunrisecommunity/observatory
• Owner: SunriseCommunity
• License: mit
• Created: 2024-10-25T05:53:17.000Z (about 2 months ago)
• Default Branch: main
• Last Pushed: 2024-11-08T12:06:06.000Z (about 1 month ago)
• Last Synced: 2024-11-08T12:27:00.413Z (about 1 month ago)
• Topics: beatmap-downloader, beatmap-mirror, bun, drizzle-orm, elysiajs, manager, osu, osugame
• Language: TypeScript
• Homepage:
• Size: 12.7 MB
• Stars: 1
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: .github/README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 🔭 Observatory - Powerful beatmap manager for osu!



  



## Description

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.

## Features

-   [x] **Plug and Use**: Just compile the docker image and run it. No need to worry about dependencies.

-   [x] **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.

-   [x] **Fastest wins the race**: The application is designed to prioritize the fastest API's first to provide the best experience.

-   [x] **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

-   [x] **Everyone loves caching**: We also have a caching layer between the requests and our database, which allows processing requests _very_ quickly

## Installation 📩

### Docker 🐳

1. Fill the `.env` file with the required data

2. Run the following command:

```bash

docker compose -f docker-compose.yml up -d # Creates the container with app and all dependencies

```

3. The application will be available at `http://localhost:3000`

### Manual 🛠

1. Clone the repository

2. Install the required dependencies: `bun install`

3. Fill the `.env` file with the required data

4. Start needed services: `bun run setup`

5. Run the application: `bun run dev`

6. The application will be available at `http://localhost:3000`

## Contributing 💖

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.

## License

This project is licensed under the MIT License. See the [LICENSE](../LICENSE) file for more details.