forked from syntaxbullet/aurorabot
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
This commit is contained in:
@@ -1,21 +1,30 @@
|
||||
# Aurora Web
|
||||
# Aurora Web API
|
||||
|
||||
To install dependencies:
|
||||
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:
|
||||
|
||||
```bash
|
||||
bun install
|
||||
bun run dev
|
||||
```
|
||||
|
||||
To start a development server:
|
||||
|
||||
```bash
|
||||
bun dev
|
||||
```
|
||||
|
||||
To run for production:
|
||||
|
||||
```bash
|
||||
bun start
|
||||
```
|
||||
|
||||
This project was created using `bun init` in bun v1.3.3. [Bun](https://bun.com) is a fast all-in-one JavaScript runtime.
|
||||
The API will be available at `http://localhost:3000`
|
||||
|
||||
Reference in New Issue
Block a user