77e43a6a38
- Created .gitignore to exclude unnecessary files - Added README.md with project description and core features - Introduced CONTRIBUTING.md for development guidelines - Established documentation files for architecture, quality requirements, and technical risks
1.6 KiB
1.6 KiB
Architecture Constraints
Technical Constraints
| Constraint | Description |
|---|---|
| Runtime | Discord Bot must run on Node.js (Discord.js) or Python (Discord.py) per existing proposal |
| Hosting | Bot process must run 24/7 — planned deployment to Coolify |
| API Limits | Discord rate limits (50 req/s per route); webhook pollers must respect YouTube/IG/TikTok quota caps |
| OAuth2 | Web app auth must use Discord OAuth2 — no custom auth service |
| Database | PostgreSQL or MongoDB required for mileage and state persistence |
Organizational Constraints
| Constraint | Description |
|---|---|
| Development | Internal team only; no open-source contributions from outside |
| Deployment | Admin dashboard hosted at admin.openmicodyssey.com — CORS and subdomain config required |
| Branding | All documentation, embeds, and UI must reflect "Open Mic Odyssey" road-trip theme |
Conventions
- Git commit messages follow Conventional Commits format
- Environment variables stored in
.env, never committed - Slash commands registered via
deploy-commandsscript, not manual guild config