Skip to content

onboarding.md

Latest commit

 

History

History
54 lines (41 loc) · 1.82 KB

onboarding.md

File metadata and controls

54 lines (41 loc) · 1.82 KB

Onboarding

Prerequisites

  • Python 3.11+ installed
  • Node.js 22+ installed (for Editly and HyperFrames renderers)
  • FFmpeg 6+ and ffprobe installed
  • Redis installed (for async mode; optional for sync-only local dev)
  • uv package manager installed (recommended) or pip
  • Git configured
  • Docker Engine 24+ and Compose v2 (for containerized stack)

Setup Steps

  1. Clone: git clone <repo-url> && cd vidapi
  2. Create venv: uv venv .venv && source .venv/bin/activate
  3. Install: uv pip install -e ".[dev]"
  4. Start (sync): uvicorn app.main:app --reload
  5. Start (async): redis-server & then RENDER_MODE=async uvicorn app.main:app --reload and arq app.workers.arq_settings.WorkerSettings in a separate terminal

Required Fonts

The text renderer requires at least one of these font families:

  • Inter (preferred) -- fonts-inter on Debian/Ubuntu
  • Noto Sans -- fonts-noto on Debian/Ubuntu
  • DejaVu Sans -- fonts-dejavu-core on Debian/Ubuntu

Verify Setup

  • API runs at http://localhost:8000
  • Health check passes: curl http://localhost:8000/v1/health
  • Tests pass: pytest (full suite, no Redis required)
  • Lint passes: ruff check .
  • Types pass: mypy app/

Docker Alternative (Recommended for Full Stack)

docker compose up --build
curl http://localhost:8000/v1/health
bash scripts/smoke-test.sh     # End-to-end async render test

Key Files to Read First

File Purpose
.spec_system/PRD/PRD.md Full product requirements
.spec_system/CONVENTIONS.md Coding standards
docs/ARCHITECTURE.md System design and data flow
app/models/composition.py Public JSON schema
app/renderers/editly.py Segment compiler and Editly bridge
app/services/render_service.py Render pipeline orchestration