THIS PAGE IS THE ACTUAL FILE THAT SHIPS IN THE REPOSITORY — PUBLISHED SO YOU CAN JUDGE THE OPERATIONAL COST BEFORE YOU PAY.

Quick start

Goal: a fully working Vigil — app, worker, database, demo data — in under 10 minutes.

Option A — Docker (recommended, ~5 minutes)

Requirements: Docker with Compose.

# 1. Configure the one required secret
echo "BETTER_AUTH_SECRET=$(openssl rand -base64 32)" > .env

# 2. Boot everything: Postgres 18 → migrations → app → worker
docker compose up --build -d

# 3. (Optional) seed the demo organization with 90 days of history
docker compose run --rm worker npx tsx scripts/seed-demo.ts

Open http://localhost:3000.

Option B — Local development (~10 minutes)

Requirements: Node.js ≥ 20.9, PostgreSQL ≥ 18 (native uuidv7() is used).

npm install
cp .env.example .env        # set DATABASE_URL + BETTER_AUTH_SECRET
npm run db:migrate
npm run db:seed             # optional demo data
npm run dev                 # terminal 1 — app on :3000
npm run worker:dev          # terminal 2 — background checks

Verify the install

npm run typecheck && npm run lint && npm test   # 135 tests, ~2s

Where to go next

You want to… Read
Deploy to production docs/DEPLOYMENT.md
Rebrand / extend it docs/CUSTOMIZATION.md
Run a public read-only demo docs/DEMO.md
Understand the design ARCHITECTURE.md
Day-to-day development docs/HANDBOOK.md
Take updates later docs/UPGRADE.md