HotPlate/discord-rpg-concept
1
0
Fork 0
forked from syntaxbullet/aurorabot
Code Pull Requests Activity
Files
f5fecb59cbb34a49a5ee84ecdeba212df7dc780d
discord-rpg-concept/api/README.md
syntaxbullet 04e5851387 refactor: rename web/ to api/ to better reflect its purpose 
The web/ folder contains the REST API, WebSocket server, and OAuth
routes — not a web frontend. Renaming to api/ clarifies this distinction
since the actual web frontend lives in panel/.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-02-14 11:37:40 +01:00

719 B
Raw Blame History

Aurora Web API

The web API provides a REST interface and WebSocket support for accessing Aurora bot data and configuration.

API Endpoints

  • GET /api/stats - Real-time bot statistics
  • GET /api/settings - Bot configuration
  • GET /api/users - User data
  • GET /api/items - Item catalog
  • GET /api/quests - Quest information
  • GET /api/transactions - Economy data
  • GET /api/health - Health check

WebSocket

Connect to /ws for real-time updates:

  • Stats broadcasts every 5 seconds
  • Event notifications via system bus
  • PING/PONG heartbeat support

Development

The API runs automatically when you start the bot:

bun run dev

The API will be available at http://localhost:3000

View Git Blame Copy Permalink