Quick Start

Run locally with Docker Compose.

compose.yaml starts PostgreSQL, Redis, migrations, web, and worker together. You can verify the health endpoint before connecting Slack.

Required

Prerequisite

Docker Compose. Use Node.js 22.x and the Vite+ CLI vp only when developing outside containers.

Slack

Connect later

Use .env and a public HTTPS tunnel only when testing real Slack traffic.

More

Details

See the README for configuration, Slack scopes, and provider key handling.

Shortest path

Start the stack

web and worker pull in the database, Redis, and migrations. 

docker compose up --build web worker

Check health

In another shell, confirm that the HTTP server is responding.

curl http://localhost:8000/healthz

Seed a route when needed

Before testing Slack app mentions, create the bootstrap route with a workspace team id. 

AGENTS_PARTY_BOOTSTRAP_TEAM_ID=T123456789 \
docker compose --profile seed run --rm seed

Connect Slack

Fill .env, replace manifest URLs with your public HTTPS tunnel, then import the manifest into Slack. 

cp .env.example .env
docker compose up --build web worker

Watch logs

docker compose logs -f web
docker compose logs -f worker

Stop

docker compose down
docker compose down -v  # remove DB/Redis volumes too

Running outside containers

See the README Quick Start. Use the Vite+ CLI vp for normal JS/TS workflows.

Validation before a PR

Use this set before opening a pull request.

vp check
vp run typecheck
vp test
vp pack