Skip to main content

​
Prerequisites

You need:
  • Docker with Compose
  • Go
  • just
  • Node 22 with pnpm for the UI
Run brew bundle from the repo root to install the whole toolchain from the Brewfile. For Podman users, set CONTAINER_ENGINE=podman before running the commands below. See engine configuration for test requirements.

​
Run it

1

Start local infra

Brings up Postgres 16 and NATS with JetStream via Compose. Wait for both containers to report healthy. The next step runs database migrations against this Postgres.
2

Run the app

This command:
  • Runs migrations
  • Starts the control plane (in-process dispatch) and the API server in the background
  • Waits until both :8080/startupz and :8081/startupz answer
  • Finally starts the UI dev server
Once up:
  • The API listens on :8080
  • The control plane serves its health endpoints on :8081
  • The UI dev server runs on localhost:5173, proxying API calls to :8080
3

Run the tests (optional)

​
Next steps

Head to Architecture to see how these pieces relate, or Connectors to see what you can plug in as a source or sink.