Skip to content

BAND GAME WIKI

Internal knowledge base for developers and AI agents

Band Game App

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.

SectionWhat it coversJump to
ArchitectureMonorepo layout, tech stack, data flow between appsarchitecture/
Game MechanicsBand-name chain rules, turn flow, game modes, win/lossgame/
API ReferenceREST endpoints, Socket.IO events, authapi/
ServerNestJS modules, DB schema, XP system, servicesserver/
ClientExpo Router screens, state management, socket layerclient/
AdminNext.js admin dashboard — config, rewards, assetsadmin/
DeploymentRailway, EAS Build, Neon, Cloudflare R2, external servicesdeployment/
DevelopmentSetup, running locally, migrations, testingdevelopment/
RoadmapPlanned features and milestonesroadmap

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 .md file in the appropriate folder and adding it to the sidebar in .vitepress/config.mts.
  • No double-updating: This site is generated directly from the .md files. 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.

SectionStatus
ArchitectureComplete
Game MechanicsComplete
API ReferenceComplete — REST and both Socket.IO gateways fully inventoried
ServerComplete — modules, DB schema, cache, queue, push all covered
ClientComplete — screen tree, state shape, match data pipeline, hook architecture
AdminComplete — all three pages, API routes, server actions, types
DeploymentComplete — Railway, EAS, Neon, R2, no CI/CD pipeline
DevelopmentComplete — setup, migrations, linting, TypeScript, testing all covered
RoadmapPartial — Redis plan detailed, other milestones not yet tracked