Add initial project structure, including README, CONTRIBUTING, and documentation files

- 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
This commit is contained in:
2026-05-17 15:50:43 +02:00
commit 77e43a6a38
16 changed files with 692 additions and 0 deletions
+34
View File
@@ -0,0 +1,34 @@
# Introduction and Goals
## Business Goals
- **Community engagement gamification** — Drive member participation through mileage-based progression system
- **Content syndication automation** — Auto-deliver YouTube, Instagram, TikTok content to Discord channels
- **Event management simplification** — Streamline virtual "Tour Stop" screenings and open mic scheduling
- **Cross-platform bridge** — Connect Discord community with openmicodyssey.com via OAuth2
## Essential Features
- Reaction-role onboarding ("The Call Sheet")
- Event queue management with `/sign-up` command
- Automated webhook syndication ("The Dailies")
- Mileage-based progression system
- Admin web dashboard ("The Control Room")
## Quality Goals
| Priority | Goal | Scenario |
| -------- | ---------------- | ------------------------------------------------------------------------------------- |
| 1 | Availability | Bot responds within 2s during peak events (100+ concurrent users) |
| 2 | Data consistency | Mileage and role state survive bot restarts without drift |
| 3 | Extensibility | New content sources (Twitter, RSS) addable via adapter without core changes |
| 4 | Security | OAuth2 tokens never exposed; role assignments authorized via Discord permission model |
## Stakeholders
| Role | Contact | Expectation |
| ----------------- | ------------------ | ------------------------------------------------------- |
| Community Manager | @producers | Easy event scheduling, content automation |
| Developer | @directors | Clean codebase, documented APIs, testable |
| End User | @community | Fun onboarding, seamless XP tracking, reliable commands |
| Site Owner | openmicodyssey.com | Secure OAuth2 bridge, accurate mileage sync |