Reference
Scripts
The root package.json scripts for developing, validating, building, and deploying the monorepo with Bun and Turborepo.
Run these from the repo root with bun run <script>. They orchestrate the
workspaces through Turborepo. Use Bun, not npm/pnpm/yarn.
Develop
| Script | What it does |
|---|---|
dev | Run every app and the Convex backend together. |
dev:app | Run the product app (apps/app, port 3000) only. |
dev:marketing | Run the marketing site (apps/marketing, port 3002) only. |
dev:docs | Run this documentation site (apps/docs, port 3004) only. |
dev:convex | Run the Convex backend dev server only. |
dev:email | Run the React Email preview server. |
Build and run
| Script | What it does |
|---|---|
build | Run check-env, then build every workspace. |
start:app / start:marketing / start:docs | Start a built app in production mode. |
Validate
| Script | What it does |
|---|---|
check-env (alias setup:doctor) | Run the environment doctor across workspaces. |
release:check | Run launch env validation, lint, typecheck, tests, and build in release-gate order. |
typecheck | TypeScript checks across all workspaces. |
lint | Biome lint across workspaces, then repo-level sherif and Turborepo boundary checks. |
lint:boundaries | Run Turborepo boundary checks for source packages. |
lint:repo / lint:repo:fix | Run (or autofix) the sherif workspace-consistency lint. |
format | Format the repo with Biome. |
test | Run all workspace tests and the env-doctor tests. |
Maintenance
| Script | What it does |
|---|---|
clean | Remove the root node_modules. |
clean:workspaces | Run each workspace's clean (build artifacts, caches). |
Individual workspaces expose their own scripts; run them with
bun --cwd <workspace> run <script> (for example
bun --cwd apps/app run typecheck).
Environment Variables
A quick reference to every environment variable grouped by where it lives, with required values marked. See the Environment Variables guide for full descriptions.
Convex Functions Reference
This is a lightweight map of app-owned Convex functions. Generated function references live under packages/backend/convex/_generated.