MusicBox API

Web interface and API for the MusicBox IRC bot database. See #randommusic on Rizon.

Prerequisites

• Node.js v18+
• MySQL or MariaDB with the ircbot database (schema from IRCMusicBot, including the V3 aliases migration)

Setup

npm install
cp config.js.example config.js   # then fill in your DB credentials
npm start                         # runs on http://localhost:5000

Pages

Route	Description
/	Top 50 leaderboard
/links?nickname=<nick>	Video list for a user (alias-aware)
/help	Bot commands reference

API Endpoints

Route	Description
GET /api/leaderboard	Paginated leaderboard (?page=N)
GET /api/users	Paginated user list
GET /api/videos?userid=<id>	Videos posted by a user

Deployment

The app is deployed via GitHub Actions (rsync + PM2). The PM2 process must be named API:

cd /home/musicbox/api/production
pm2 start server.js --name API
pm2 save

config.js is protected from rsync overwrites by the deploy workflow.

License

MIT

Docker

sux: 69420