1.4 KiB
1.4 KiB
T YouTube — Text-Based YouTube Digest
PDD Workflow
This project follows PDD (Product Definition Document) development.
Always read these files before writing code:
docs/PDD.md— product vision, goals, targets (the north star)docs/specs/active.md— current sprint spec (what we're building now)
Workflow:
- PDD → Sprint Spec → Implementation → Validate ACs
- Scope changes update the sprint spec first, code second
- Never ship without ACs passing
Dev Commands
- Build:
docker compose up -d --build - Test:
./run_tests.sh - Run locally:
uvicorn backend.main:app --reload(backend) +npm run dev(frontend) - Sync subscriptions:
python run_sync.py
Architecture
- Frontend: Svelte 5 + Vite (
frontend/) - Backend: FastAPI + SQLite (
backend/) - Deployment: Docker container on NAS DS224+, port 8001
- Sync:
run_sync.pyfetches YouTube subscriptions + transcripts via yt-dlp - Auth: Authelia SSO in front, cookie-based session
- Proxy: YouTube blocked from China — sync runs via VPS (Oracle Tokyo) or proxy
Key Files
docs/architecture.md— full architecture referenceDockerfile— multi-stage build (node → python)docker-compose.yml— deployment configrun_sync.py— subscription sync entry pointconfig/cookies.txt— YouTube auth cookies (not committed)