Quickstart

This page gets a full local instance running: API server, web UI, Postgres, and the ElectricSQL sync engine.

Requirements

You need Node 22 or later, pnpm, and Docker (or any Postgres with wal_level=logical, which the sync engine requires).

Install and start the services

pnpm install
docker compose up -d db electric
cp .env.example apps/web/.env

Docker Compose starts Postgres with wal_level=logical already set, plus Electric.

Push the schema and seed a workspace

pnpm db:push
pnpm seed -- --workspace "My Company" --email you@example.com --name "You" --team ACME

pnpm seed prints an API key (vt_...) once, on that run only. Store it somewhere safe: there is no way to retrieve it again later, only to create a new one.

Run it

pnpm dev

This runs the API server on port 3000 and the Vite dev server on port 5173. Open http://localhost:5173, it proxies /api requests to the server. In production, pnpm build && pnpm start runs everything as a single process on port 3000, serving both the API and the built UI.

Next steps

• Sign in with the email you seeded. Without SMTP configured, the one time code prints to the server log.
• Point an MCP client at the local server, see MCP.
• Make your first API call, see API overview.
• Ready to put this somewhere real? See Self hosting.