Skip to content

local-setup.md

Latest commit

 

History

History
56 lines (39 loc) · 1.28 KB

local-setup.md

File metadata and controls

56 lines (39 loc) · 1.28 KB
Raw

Local setup

Use this when you want to run the app from your own computer instead of only through Cloudflare.

Install Vite+

On macOS or Linux:

curl -fsSL https://vite.plus | bash

On Windows PowerShell:

irm https://vite.plus/ps1 | iex

Open a new terminal after installing Vite+. Enable the package-manager shims, then install dependencies:

corepack enable
pnpm install

Run the app

From the repository root:

pnpm run dev

pnpm run dev starts Convex and TanStack Start together. On the first run, Convex may ask you to sign in and choose or create a development deployment. The dev script also creates Convex Auth JWT keys in that development deployment if they are missing. In a linked Git worktree, it automatically uses an isolated local backend.

Open the local URL printed by Vite.

Force worktree mode

Use the normal pnpm run dev command in a linked Git worktree. Use the explicit worktree command to force an isolated local backend in another checkout.

pnpm run dev:worktree

The context launcher selects run-primary-dev.ts or run-worktree-dev.ts. Both modes use the same Windows-safe service launcher. The three launcher files carry one shared content hash in their first line, and pnpm run check verifies that hash.