Documentation / Getting started
Start
Getting started
Install the toolchain and run the full stack locally.
Requirements
- Node.js 24 or newer
- pnpm 10
- A local or cloud Convex deployment
Install and initialize
Install workspace dependencies, initialize a local Convex deployment, select it, and configure Convex Auth.
pnpm install
pnpm db:local:init
pnpm db:local:select
pnpm auth:setup
pnpm dev:localVerify the workspace
Before shipping a change, run the repository quality gates.
pnpm format:check
pnpm lint
pnpm typecheck
pnpm test
pnpm build