alex
a4cabbd2b8
- Remove OCR noise, credits, and duplicates from rules-database.json (288→255 rules) - Add clean_rules.py script for rule cleanup - Add CLAUDE.md, docs/, and update README with documentation links Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
53 lines
1.7 KiB
Markdown
53 lines
1.7 KiB
Markdown
# Deathwatch Roller Documentation
|
|
|
|
## Overview
|
|
|
|
This documentation covers the Deathwatch Roller application - a React-based web app for managing Deathwatch tabletop RPG sessions.
|
|
|
|
## Getting Started
|
|
|
|
- [Quick Start Guide](./quick-start.md) - Installation and setup
|
|
- [User Guide](./user-guide.md) - Features and how to use the app
|
|
- [API Documentation](./api.md) - REST API reference
|
|
- [Developer Guide](./developer-guide.md) - Contributing to the project
|
|
- [Troubleshooting](./troubleshooting.md) - Common issues and solutions
|
|
- [Security Guide](./security.md) - Security best practices
|
|
- [PM2 Configuration](./pm2.md) - Production deployment
|
|
|
|
## Project Structure
|
|
|
|
```
|
|
dwroller/
|
|
├── backend/ # Backend API server
|
|
├── frontend/ # React frontend application
|
|
├── data/ # Static data and assets
|
|
├── database/ # Database backups and migrations
|
|
└── docs/ # This documentation
|
|
```
|
|
|
|
## Key Features
|
|
|
|
- **Player Management** - Full CRUD operations for player accounts
|
|
- **Requisition Shop** - Browse and purchase items with RP
|
|
- **Session Tracking** - Track game sessions and player progress
|
|
- **GM Kit** - Game Master tools and utilities
|
|
- **Bestiary** - Monster and enemy reference
|
|
- **Rules Database** - Searchable rules and mechanics
|
|
|
|
## API Endpoints
|
|
|
|
| Endpoint | Description |
|
|
|----------|-------------|
|
|
| `GET /api/players` | Get all players |
|
|
| `POST /api/players/gm/*` | GM-only operations |
|
|
| `GET /api/shop` | Get shop inventory |
|
|
| `GET /api/bestiary` | Get bestiary data |
|
|
|
|
## Contributing
|
|
|
|
See [Contributing Guide](./contributing.md) for details on how to contribute.
|
|
|
|
## License
|
|
|
|
MIT License - See [LICENSE](../../LICENSE) for details.
|