zwitschi
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
2.2 KiB
2.2 KiB
Context and Scope
Business Context
┌─────────────────┐ Discord API ┌──────────────────┐
│ Discord Users │◄───────────────────────► │ omo-bot │
│ (Community) │ slash cmds, embeds │ (Discord Bot) │
└─────────────────┘ └────────┬─────────┘
│
OAuth2 + REST │
▼
┌────────────────┐
│ openmicodyssey │
│ .com (Web App) │
└────────────────┘
Technical Context
| Partner | Protocol | Data | Description |
|---|---|---|---|
| Discord API | WebSocket (Gateway) + REST | Messages, roles, events, voice states | Bot core communication |
| YouTube Data API | HTTPS (REST + polling) | Video metadata, thumbnails | Auto-post new uploads to #screenings |
| Instagram API | HTTPS (REST + polling) | Image URLs, captions | Auto-post to #polaroids-from-the-van |
| TikTok API | HTTPS (REST + polling) | Video metadata | Auto-post to #outtakes |
| openmicodyssey.com | HTTPS (OAuth2 + REST) | User profiles, mileage data, map routes | Web session sync |
Scope
In scope: Discord bot commands, reaction-role management, event queue, content webhook syndication, mileage tracking, admin dashboard API.
Out of scope: The main openmicodyssey.com website frontend, native mobile apps, third-party content moderation.