All project documentation lives under docs/, grouped by area.
| Folder | Contents |
|---|---|
| api/ | REST API reference, backend roadmap, Stripe, NestJS README |
| web/ | Local dev / run guide, admin dashboard plan, security, stakeholder PRD, gaps |
| mobile/ | Expo APK builds, OTA updates (xprem), push notifications (Firebase/FCM) |
| tv-projector/ | Android TV / projector app setup |
| vps/ | Production VPS bootstrap and deploy notes |
- Run the stack locally: web/how-to-run.md
- API endpoints: api/api.md
- Deploy to production: vps/vps-production.md + root
INSTRUCTIONS.txt - Mobile APK + OTA + push: mobile/README.md (OTA section), mobile/notifications.md
Each app folder has a short README that points here:
api/README.md— quick start onlymobile/README.md— points todocs/mobile/tv-projector/README.md— points todocs/tv-projector/