convex-quickstart

Scaffolds new Convex projects or integrates Convex into existing frontend applications.

Updated Jul 3, 2026
One-click install
npx skills add https://github.com/alex-jordan547/agent-setup --skill convex-quickstart-alex-jordan547
Or copy as Structured Prompt for Agentâ–¼
Please help me install this Agent Skill.
Skill: convex-quickstart
Source: https://github.com/alex-jordan547/agent-setup/tree/main/archive/convex-quickstart
Command: npx skills add https://github.com/alex-jordan547/agent-setup --skill convex-quickstart-alex-jordan547

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires convex.

What problem does it solve? Setting up a Convex backend involves choosing templates, wiring the ConvexProvider correctly for each framework, configuring environment variables, and starting the dev loop, which is error-prone when done manually. ## Core Features & Use Cases - New Project Scaffolding: Creates complete projects with npm create convex@latest using templates like react-vite-shadcn, nextjs-shadcn, or auth-enabled variants. - Existing App Integration: Installs the convex package and wires up ConvexProvider with framework-specific patterns for React (Vite), Next.js App Router, Vue, Svelte, React Native, Remix, and TanStack Start. - Headless Agent Mode: Supports anonymous local deployments via CONVEX_AGENT_MODE=anonymous for cloud environments without browser login. - Use Case: A developer says "add a backend to my Next.js app" and gets Convex installed, the provider wired into the root layout, environment variables configured, and a working first query and mutation. ## Quick Start Set up Convex for this project, scaffolding a new app or integrating it into my existing frontend, then verify the dev loop works.

Frequently Asked Questions about convex-quickstart

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I set up Convex in a new project?â–¼

Run npm create convex@latest with a template flag like react-vite-shadcn or nextjs-shadcn, then run npm install. After that, start npx convex dev to create a deployment, generate types, and begin the sync loop.

How to add Convex to an existing Next.js app?â–¼

Install the convex package, run npx convex dev to generate the convex/ directory and write NEXT_PUBLIC_CONVEX_URL to .env.local, then wrap your root layout with a client component providing ConvexProvider with a ConvexReactClient created at module scope.

Can I run Convex dev in a headless or cloud environment?â–¼

Yes, set CONVEX_AGENT_MODE=anonymous in .env.local or inline before npx convex dev. This runs a local anonymous deployment without browser-based login, avoiding conflicts with personal dev deployments.

Which environment variable does Convex use for each framework?â–¼

Vite uses VITE_CONVEX_URL, Next.js uses NEXT_PUBLIC_CONVEX_URL, Remix uses CONVEX_URL, and React Native uses EXPO_PUBLIC_CONVEX_URL. Running npx convex dev writes the correct variable to .env.local automatically.

When should I not use the Convex quickstart flow?â–¼

Skip it when the project already has Convex installed with an existing convex/ directory, or when you only need to add authentication to an existing Convex app, which is handled by a dedicated auth setup flow.