Osudroid Profile
A website to display your osu!droid profile
osu!droid Profile Viewer
View detailed stats, top plays, and recent scores for any osu!droid player.
🌐 Visit Live Website
🚀 Getting Started
You can run this project in two ways:
- 🔧 Locally using Node.js + Yarn
- 🐳 Using Docker (dev or production)
✅ Prerequisites
🔧 Local Development
🐳 Docker Setup
🔑 API Key
We need an osu! API key to fetch beatmap data. You can get one
from here.
Once you have the key, create a .env file in the root directory and add the following:
OSU_CLIENT_SECRET={YOUR_CLIENT_SECRET}
OSU_CLIENT_ID={YOUR_CLIENT_ID}
📦 Local Setup
🔧 Development
# 1. Install dependencies
yarn install
# 2. Start the dev server
yarn dev
App will be available at http://localhost:3000
⚙️ Production
# 1. Build the app
yarn build
# 2. Start the server
node build/index.js
🐳 Docker Setup
🔧 Development
docker compose up -d
⚙️ Production
docker compose -f compose.prod.yml up --build -d
🛠 Tech Stack
📌 Features
- osu!droid user lookup by UID
- Top 50 plays with detailed breakdown
- Recent scores display
- Beatmap preview with audio and metadata
- Responsive and mobile-friendly
📄 License
MIT © Mysterken
🙌 Credits
