convex-quickstart

Scaffold a new Convex project or integrate Convex into an existing frontend app. Set up a working Convex project as fast as possible. Use the official scaffolding tool. It creates a complete project with the frontend framework, Convex backend, and all config wired together. If the user has not specified a preference, default to react-vite-shadcn for simple apps or nextjs-shadcn for apps that need SSR or API routes. You can also use any GitHub repo as a template: Always pass the project name and template flag to avoid interactive prompts: The scaffolding tool creates files but does not run npm install , so you must run it yourself. To scaffold in the current directory (if it is empty): npx convex dev is a long-running watcher process that syncs backend code to a Convex deployment on every save. It also requires authentication on first run (browser-based OAuth).