HotPlate/discord-rpg-concept
1
0
Fork 0
forked from syntaxbullet/aurorabot
Code Pull Requests Activity
Files
bf20c611908ae6607d7f6c2fb51570f896e1d600
discord-rpg-concept/web/README.md
syntaxbullet 73ad889018 docs: update documentation to reflect headless API-only web service 
- AGENTS.md: Update project description from web dashboard to REST API

- README.md: Replace Web Dashboard section with REST API, update tech stack

- docs/main.md: Refactor Web Dashboard section to REST API documentation

- web/README.md: Rewrite from React setup to API endpoint documentation

All React/UI references removed - web is now API-only
2026-02-12 12:30:43 +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