mystiatech/Vivi-Speech
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
901574f8c8ce62cc44afcb4de96d7f63e8995d4f
Vivi-Speech/.planning/research/INDEX.md
Dani B 901574f8c8 docs: complete project research (STACK, FEATURES, ARCHITECTURE, PITFALLS, SUMMARY) 
Synthesized research findings from 4 parallel researcher agents:

Key Findings:
- Stack: discord.py 2.6.4 + PostgreSQL/SQLite with webhook-driven PluralKit integration
- Architecture: 7-component system with clear separation of concerns, async-native
- Features: Rule-based learning system starting simple, avoiding context inference and ML
- Pitfalls: 8 critical risks identified with phase assignments and prevention strategies

Recommended Approach:
- 5-phase build order (detection → translation → teaching → config → polish)
- Focus on dysgraphia accessibility for teaching interface
- Start with message detection reliability (Phase 1, load-bearing)
- Shared emoji dictionary (Phase 1-3); per-server overrides deferred to Phase 4+

Confidence Levels:
- Tech Stack: VERY HIGH (all production-proven, no experimental choices)
- Architecture: VERY HIGH (mirrors successful production bots)
- Features: HIGH (tight scope, transparent approach)
- Roadmap: HIGH (logical phase progression with value delivery)

Gaps to Address in Requirements:
- Vivi's teaching UX preferences (dysgraphia-specific patterns)
- Exact emoji coverage and naming conventions
- Moderation/teaching permissions model
- Multi-system scope and per-system customization needs

Ready for requirements definition and roadmap creation.

Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
2026-01-29 11:02:32 -05:00

249 lines
7.5 KiB
Markdown
Raw Blame History

# Vivi Speech Translator - Research Index
**Research Date:** January 29, 2025
**Status:** Complete
**Total Documentation:** 2,900 lines across 7 files
---
## Quick Navigation
### I Want to...
**Get a quick overview fast** → Read [QUICK_REFERENCE.md](./QUICK_REFERENCE.md) (5 min read)
- Installation checklist
- One-page tech summary
- Code examples
- Common commands
**Understand the detailed reasoning** → Read [STACK.md](./STACK.md) (15 min read)
- Comprehensive analysis of all 7 research questions
- Production-ready recommendations
- Anti-patterns to avoid
- Implementation roadmap
- Cost breakdown
**Review existing files in project** → Check other *.md files in this directory
- [ARCHITECTURE.md](./ARCHITECTURE.md) - Project structure planning
- [FEATURES.md](./FEATURES.md) - Feature specifications
- [PITFALLS.md](./PITFALLS.md) - Common mistakes to avoid
- [README.md](./README.md) - Overview
---
## The 7 Key Questions - Quick Answers
| Question | Answer | Confidence | Location |
|----------|--------|------------|----------|
| **1. Best Discord bot framework?** | discord.py 2.6.4 (Python) | ✅ HIGH | STACK.md §1 |
| **2. Best language to use?** | Python 3.10+ | ✅ HIGH | STACK.md §2 |
| **3. Database for emoji mappings?** | SQLite (MVP) → PostgreSQL (prod) | ✅ HIGH | STACK.md §3 |
| **4. How to integrate PluralKit?** | pluralkit.py + webhook dispatch | ✅ HIGH | STACK.md §4 |
| **5. Standard emoji/text libraries?** | emoji 2.11.0+, pydantic 2.5.0+ | ✅ HIGH | STACK.md §5 |
| **6. Best hosting option?** | Railway ($0-5/mo) or Oracle Cloud (free) | ✅ HIGH | STACK.md §6 |
| **7. Authentication best practices?** | Slash commands, no MessageContent intent | ✅ HIGH | STACK.md §7 |
---
## File Guide
### STACK.md (690 lines) - PRIMARY RESEARCH DOCUMENT
**Read this for:** Complete analysis with full rationale
**Key Sections:**
- Executive Summary (2-3 sentence overview)
- Discord Bot Framework analysis (includes why NOT Pycord)
- Language comparison (Python vs JS vs Rust vs Go)
- Database schema and comparison (SQLite vs PostgreSQL)
- PluralKit integration mechanism (how webhooks work)
- Key libraries table (with versions and installation)
- Hosting options (Railway, Oracle Cloud, self-hosted)
- Authentication/Permissions guide (intents, OAuth2)
- Anti-patterns (7 major mistakes to avoid)
- Implementation roadmap (4 phases over 6-8 weeks)
- Cost breakdown (monthly expenses by phase)
- References (10 authoritative sources)
**Use this to:**
- Explain tech choices to stakeholders
- Understand production requirements
- Plan implementation phases
- Avoid common pitfalls
---
### QUICK_REFERENCE.md (351 lines) - DEVELOPER START GUIDE
**Read this for:** Get started immediately with code examples
**Key Sections:**
- Installation checklist (copy-paste pip commands)
- Database quick start (SQLite code, PostgreSQL connection string)
- PluralKit integration checklist (7-step verification)
- Slash commands example (vs prefix commands)
- Environment variables template (.env setup)
- Bot intents configuration (what to enable/disable)
- Hosting setup instructions (Railway CLI commands)
- Common development commands
- Anti-patterns summary (7 DON'Ts)
- Testing examples (pytest code)
- Troubleshooting table (6 common issues)
- Next steps checklist
**Use this to:**
- Set up local development environment
- Copy code templates
- Find command syntax
- Quick-fix common problems
- Deploy to production
---
### Other Files in Directory
**ARCHITECTURE.md** (774 lines)
- Existing project structure planning
- System design diagrams
- Module organization
- Data flow
**FEATURES.md** (546 lines)
- Feature specifications
- User stories
- Requirements breakdown
- Acceptance criteria
**PITFALLS.md** (506 lines)
- Common mistakes teams make
- Why each pitfall happens
- How to avoid/fix them
**README.md** (33 lines)
- Directory overview
- File purposes
---
## Tech Stack at a Glance
```
Bot Framework: discord.py 2.6.4 (Python)
Database: SQLite (MVP) → PostgreSQL (prod)
PluralKit: pluralkit.py + webhook dispatch
Hosting: Railway ($0-5/mo) or Oracle Cloud (free)
Commands: Slash commands (/)
Cost (MVP): $0/month
Cost (Prod): $0-20/month
Confidence: VERY HIGH (all 2025-current)
```
---
## Implementation Phases
### Phase 1: MVP (Weeks 1-2) - $0/month
- discord.py + SQLite
- `/learn 🎭 "meaning"` and `/translate` commands
- Local testing
### Phase 2: PluralKit (Weeks 3-4) - $5/mo
- Webhook endpoint
- Member detection
- System caching
### Phase 3: Production (Weeks 5-6) - $0-15/mo
- PostgreSQL migration
- Deploy to Railway
- Error tracking
### Phase 4: Scaling (Weeks 7+) - $20-50/mo
- Global emoji dictionary
- Per-server overrides
- Analytics dashboard
- Redis caching (optional)
---
## Before You Start
### Required Setup
- [ ] Python 3.10+ installed locally
- [ ] Create Discord application (Discord Developer Portal)
- [ ] Get PluralKit system token (run `pk;token` in Discord)
- [ ] Read STACK.md and QUICK_REFERENCE.md
- [ ] Understand anti-patterns section
### Avoid These Common Mistakes
1. Don't use Pycord (unmaintained since 2023)
2. Don't store bot token in code (use .env)
3. Don't request MessageContent intent (use slash commands)
4. Don't poll PluralKit API (use webhooks instead)
5. Don't use synchronous database calls
6. Don't write custom webhook signature code
7. Don't let emoji history table grow unbounded
### Recommended First Step
1. Read QUICK_REFERENCE.md (10 min)
2. Set up Python environment (15 min)
3. Create Discord bot in Developer Portal (5 min)
4. Get PluralKit token (1 min)
5. Start coding MVP (then reference STACK.md for details)
---
## High-Confidence Decisions
These recommendations have **VERY HIGH confidence** because they are:
✓ Based on 2025 current releases (discord.py 2.6.4, released Oct 2025)
✓ Production-proven (used by 1000+ Discord bots)
✓ Actively maintained (discord.py: new version every 3 months)
✓ Community-tested (largest Python Discord bot community)
✓ Cost-effective (minimal infrastructure required)
✓ Future-proof (no deprecated technologies)
None of the recommendations are speculative or "experimental."
---
## What NOT in This Research
This research focuses on **2025 production-ready tech stack**, not:
- ❌ Machine learning for emoji translation (beyond scope)
- ❌ Advanced NLP processing (emoji library sufficient)
- ❌ Real-time synchronization across 1000+ servers (future phase)
- ❌ Custom Discord bot framework creation (use existing)
- ❌ Legacy Python 2.7 support (use Python 3.10+)
---
## Questions?
If you have questions about these recommendations:
1. **Specific library question?** → Check "Key Libraries" table in STACK.md
2. **How does PluralKit work?** → See "PluralKit Integration" section in STACK.md
3. **How to set up locally?** → Follow "Installation Checklist" in QUICK_REFERENCE.md
4. **What to avoid?** → Review "Anti-patterns" section in STACK.md
5. **Need example code?** → See code examples in QUICK_REFERENCE.md
6. **Cost concerns?** → Check "Cost Breakdown" in STACK.md
---
## Summary
The **2025 tech stack for Vivi Speech Translator** is:
- **Framework:** discord.py 2.6.4 (Python 3.10+)
- **Database:** SQLite (MVP) → PostgreSQL (production)
- **Integration:** pluralkit.py + webhook dispatch
- **Hosting:** Railway Cloud ($0-5/month)
- **Confidence:** Very High (all current, production-proven)
**Start here:** Read QUICK_REFERENCE.md, then reference STACK.md for deep dives.
---
*Last Updated: January 29, 2025*
*Maintained for: Vivi Speech Translator Project*
Reference in New Issue View Git Blame Copy Permalink