BAND GAME WIKI
Internal knowledge base for developers and AI agents
Skip to content
Quick Lookup Index
Use this index to find documentation without reading source code. Each section links to an overview page; gaps are marked "Needs further exploration" so you know what isn't documented yet.
| Section | What it covers | Jump to |
|---|---|---|
| Architecture | Monorepo layout, tech stack, data flow between apps | architecture/ |
| Game Mechanics | Band-name chain rules, turn flow, game modes, win/loss | game/ |
| API Reference | REST endpoints, Socket.IO events, auth | api/ |
| Server | NestJS modules, DB schema, XP system, services | server/ |
| Client | Expo Router screens, state management, socket layer | client/ |
| Admin | Next.js admin dashboard — config, rewards, assets | admin/ |
| Deployment | Railway, EAS Build, Neon, Cloudflare R2, external services | deployment/ |
| Development | Setup, running locally, migrations, testing | development/ |
| Roadmap | Planned features and milestones | roadmap |
How to Use This Wiki
- AI agents: Read the index page of the relevant section first. Follow "Needs further exploration" markers to find what isn't documented — those point to the source files to read instead.
- Developers: Add new pages by creating a
.mdfile in the appropriate folder and adding it to the sidebar in.vitepress/config.mts. - No double-updating: This site is generated directly from the
.mdfiles. Edit the markdown, the site reflects it immediately.
Exploration Status
Sections marked with the callout below contain known gaps and need a dedicated documentation pass:
Needs further exploration: This section's documentation is incomplete. See the source files referenced for current implementation details.
| Section | Status |
|---|---|
| Architecture | Complete |
| Game Mechanics | Complete |
| API Reference | Complete — REST and both Socket.IO gateways fully inventoried |
| Server | Complete — modules, DB schema, cache, queue, push all covered |
| Client | Complete — screen tree, state shape, match data pipeline, hook architecture |
| Admin | Complete — all three pages, API routes, server actions, types |
| Deployment | Complete — Railway, EAS, Neon, R2, no CI/CD pipeline |
| Development | Complete — setup, migrations, linting, TypeScript, testing all covered |
| Roadmap | Partial — Redis plan detailed, other milestones not yet tracked |