Skip to main content

Quickstart

Open The App​

The web app lives in:

web

It is a Vercel app made of static HTML pages and web/api/*.js serverless routes.

Local static pages can be opened directly, but live routes need the Vercel or local serverless environment with the right env vars.

Run The Docs Site​

cd docs-site
npm install
npm run start

Build it before shipping:

npm run build

Developer setup and tests​

The canonical editor-neutral guide is DEVELOPMENT.md at the repository root. Start with:

nvm use
npm run bootstrap
npm run doctor
npm run check

npm run check covers CI's workspace tests, typecheck, manifests, and docs build, and additionally runs the web production build and developer-tooling tests. Run it locally before a PR while those two steps are absent from CI.

Check Supabase State​

From supabase:

supabase migration list
supabase functions list

Compare the current repository migration ledger with the linked project. Do not assume a fixed final migration number, and do not apply migrations from a workstation.

Connector smoke tests​

Connector smoke tests call production services and are operator actions, not first-day local setup. Use the checked-in test suites and PR preview first. An operator runs the documented smoke workflow after merge with approved credentials and records the result.

First Files To Read​

  • README.md
  • DEVELOPMENT.md
  • SABLE.md
  • CLAUDE.md
  • CONNECTOR-SETUP.md