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>
1.7 KiB
1.7 KiB
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 - Installation and setup
- User Guide - Features and how to use the app
- API Documentation - REST API reference
- Developer Guide - Contributing to the project
- Troubleshooting - Common issues and solutions
- Security Guide - Security best practices
- PM2 Configuration - 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 for details on how to contribute.
License
MIT License - See LICENSE for details.