IntentLayerDocsDashboard ↗
Docs/Getting Started
Getting Started

Running locally

Start backend, dashboard, Postgres, migration, and deterministic seed with Docker Compose.

Requirements: Docker. Python 3.11+ is needed for CLI examples and SDK development.

#Start stack

bash
docker compose up --build

Open:

  • Landing and docs: http://localhost:3000 and http://localhost:3000/docs
  • Seeded dashboard: http://localhost:3000/demo
  • FastAPI Swagger: http://localhost:8000/docs
  • Health: http://localhost:8000/health

Use alternate ports:

bash
BACKEND_PORT=18000 DASHBOARD_PORT=13000 docker compose up --build

#What Compose runs

Compose starts Postgres, FastAPI backend, and Next.js dashboard. Backend startup runs Alembic migrations, then idempotent demo seed, then Uvicorn. Default local scorer and embedding modes are deterministic heuristic/hash variants.

#Hosted-demo behavior locally

bash
docker compose -f docker-compose.yml -f docker-compose.demo.yml up --build

DEMO_MODE=true keeps POST /v1/playground open and rejects writable POST /v1/gate and POST /v1/events with 403. Read APIs use seeded demo tenant.

#Verify

bash
curl http://localhost:8000/health
curl http://localhost:8000/v1/playground \
  -H "content-type: application/json" \
  -d '{"request":"cancel my order"}'
Source truthREADME.mddocker-compose.ymldocker-compose.demo.yml