ilia
655a12963b
Replace marketing feature walls with a plain install/config README and short entry guides per project-template docs/writing-docs.md.
1.7 KiB
1.7 KiB
Quick start
Day-to-day commands for the web stack (API + admin + viewer). Full install is in the root README.
Run
Three terminals from the repo root (venv activated for the API):
./run_api_with_worker.sh
# API: http://127.0.0.1:8000 docs: /docs
cd admin-frontend && npm run dev
# http://localhost:3000
cd viewer-frontend && npx prisma generate # once / after schema change
npm run dev
# http://localhost:3001
Stop the API/worker with ./stop_backend.sh or Ctrl+C in that terminal.
Common tasks
| Task | Where |
|---|---|
| Scan a photo folder | Admin → Scan |
| Detect faces | Admin → Process |
| Name faces | Admin → Identify |
| Auto-match | Admin → Auto-Match |
| Browse library | Viewer at :3001 |
| API explore | http://127.0.0.1:8000/docs |
Troubleshooting
| Symptom | Fix |
|---|---|
ModuleNotFoundError: backend |
Use ./run_api_with_worker.sh or set PYTHONPATH to the repo root |
| Port 8000 in use | ./stop_backend.sh or pkill -f "uvicorn.*backend.app" |
| Redis down | redis-cli ping; start with redis-server or brew services start redis |
| Browse returns 503 | Install tkinter (python3-tk on Debian) |
| Viewer shows 0 photos | Confirm viewer-frontend DATABASE_URL, run npx prisma generate, photos marked processed |
Tests and lint
npm run ci:local # lint frontends + ruff + pytest + builds
npm run test:e2e # Playwright (see e2e/README.md)
Legacy desktop / CLI
Older dashboard and CLI entrypoints (run_dashboard.py, src.photo_tagger)
may still exist for local experiments. Prefer the web stack above for
current development.