Getting Started
Prerequisites
-
Node.js 24.x — nodejs.org (or a version manager aimed at 24). Wrong majors break
better-sqlite3. -
pnpm 11.17.0 via Corepack — pinned at the repo root
packageManagerfield. Do not install pnpm globally with npm; do not runcorepack useonly insidesite-nextjs/. -
PowerShell 7+ recommended on Windows (5.1 often works; some scripts assume 7).
-
Sign up for a Square Developer account
-
Sign up for a Radar SDK account (required for location services)
-
Map tiles: OpenFreeMap by default (no account required)
-
Sign up for a Convex account
Workspace layout, the four pnpm members, and allowBuilds: Tooling: Node, pnpm, and the monorepo.
Quick Start
2. Activate the pinned pnpm and install
Always from the repository root (where pnpm-workspace.yaml and pnpm-lock.yaml live):
corepack enable
corepack prepare pnpm@11.17.0 --activate
pnpm --version
pnpm install
If pnpm prompts about dependency build scripts, run pnpm approve-builds (writes into pnpm-workspace.yaml → allowBuilds).
3. Configure environment variables
cd site-nextjs
copy .env.example .env.local
Populate .env.local with your API keys. See Environment variables.
4. Start Convex (separate terminal)
From site-nextjs:
pnpm exec convex dev
This syncs schema/functions and keeps a local Convex connection.
Available Scripts (in site-nextjs)
-
pnpm dev— development server (Turbopack) -
pnpm build— production build -
pnpm start— serve the production build -
pnpm lint— Next.js lint -
pnpm format/pnpm format:fix— dprint check / write -
pnpm format:biome— Biome format write
After Convex schema changes
Keep pnpm exec convex dev running locally (or deploy Convex in CI) so pnpm build and runtime queries match the deployment.
For social previews, set NEXT_PUBLIC_APP_URL — see Environment variables.
Feature overview: Events and host venues.
Manual Setup
If Corepack/workspace install fails, see Manual Setup.