Install and configure developers

Follow the source instructions for developers. Read the prerequisites and configuration steps before running an example.

Prerequisites

Node.js 18+ or Bun
A Convex account

Quick Start

1# Install dependencies
2bun install
3# or: npm install
4 
5# Copy environment template
6cp .env.example .env.local
7 
8# Add your Convex URL to .env.local, then:
9bun dev
10# or: npm run dev

App runs at http://localhost:3003.

Environment

Copy .env.example to .env.local and fill in:

1CONVEX_DEPLOYMENT=          # From `npx convex dev`
2NEXT_PUBLIC_CONVEX_URL=     # From Convex dashboard
3NEXT_PUBLIC_CONVEX_SITE_URL= # From Convex dashboard
4NEXT_PUBLIC_SITE_URL=       # http://localhost:3003 (dev) or your domain (prod)

Run npx convex dev to create/link a Convex project and get these values.

Check the installation

After setup, continue with the first example. If a command fails, compare the runtime version, working directory, and required configuration with the original README before changing dependencies.

Source and help