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
+20
View File
@@ -0,0 +1,20 @@
# Risks and Technical Debts
## Identified Risks
| Priority | Risk | Likelihood | Impact | Mitigation |
| -------- | ------------------------------------------------ | ---------- | -------- | --------------------------------------------------------------- |
| High | API quota exhaustion (YouTube/TikTok) | Medium | High | Cache aggressively; add quota alerts; stagger poll intervals |
| High | Discord rate limit bans if polling misconfigured | Low | Critical | Implement proper backoff; respect `Retry-After` headers |
| Medium | OAuth2 token expiry during web session | Medium | Medium | Implement refresh token rotation; warn user before expiry |
| Medium | Single-process bot: any crash = total downtime | Medium | High | Use process manager (PM2); deploy to platform with auto-restart |
| Low | Mileage database drift between bot and web app | Low | Medium | Periodic reconciliation job (nightly) |
## Technical Debts
| Item | Area | Description | Priority |
| ---------------- | ------ | -------------------------------------- | -------- |
| No test coverage | All | Tests not implemented for any module | High |
| No CI pipeline | DevOps | Lint + test not automated in PRs | High |
| Inline config | Bot | Some settings hardcoded instead of env | Medium |
| Manual deploy | DevOps | No deployment script / IaC yet | Medium |