Skip to main content

Local development

This marketing repository only ships the public site. To hack on Streamdat itself, work in the Streamdat_app monorepo (backend + frontend + infra).

Clone and configure

  1. Clone the Streamdat application repository (internal name: Streamdat_app).
  2. Copy .env.example to .env and set database, Redis, JWT, and object-storage variables per docs/STANDUP_RUNBOOK.md.
  3. Start the stack with docker compose up -d --build or run backend and frontend processes natively if you prefer hot reload.

URLs in development

Frontend typically listens on http://localhost:3000 and the API on http://localhost:8000 with Swagger at /api/docs.

Tests

Backend: cd backend && python -m pytest tests/ -v. Frontend: Typecheck, Vite build, and Vitest as documented in the app README.

MkDocs runbooks

Inside Streamdat_app, pip install -r requirements-docs.txt && mkdocs serve serves the full operator documentation tree under docs/ (plugins deep dive, API reference regeneration, security guide, and more).