convex-quickstart

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

Updated Aug 12, 2026
One-click install
npx skills add https://github.com/JuanQuenga/statsconnect --skill convex-quickstart-juanquenga
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: convex-quickstart
Source: https://github.com/JuanQuenga/statsconnect/tree/main/apps/clashcrown/.agents/skills/convex-quickstart
Command: npx skills add https://github.com/JuanQuenga/statsconnect --skill convex-quickstart-juanquenga

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires convex.

What problem does it solve? Setting up a Convex backend involves choosing templates, provisioning deployments, wiring providers, and configuring environment variables, which is error-prone when done manually. This Skill walks through the entire setup so a working Convex project is running in minutes. ## Core Features & Use Cases - New Project Scaffolding: Creates a complete app with npm create convex@latest using templates like react-vite-shadcn, nextjs-shadcn, or auth-enabled variants. - Existing App Integration: Installs the convex package, wires the ConvexProvider into React, Next.js, Vue, Svelte, or other frameworks, and configures the correct environment variables. - Agent-Friendly Provisioning: Uses npx convex dev --once with anonymous agent mode to provision a local deployment, push code, typecheck, and validate the schema in one shot. - Use Case: You have an existing Next.js app and want a realtime backend. The Skill installs Convex, creates the ConvexClientProvider, sets NEXT_PUBLIC_CONVEX_URL, and verifies a query/mutation round-trip works. ## Quick Start Set up Convex for this project, deciding whether it is a new or existing app, then scaffold or integrate Convex and verify the setup works.

Frequently Asked Questions about convex-quickstart

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

FAQPage Schema
How do I create a new Convex project?▼

Run npm create convex@latest with a project name and template flag, such as react-vite-shadcn or nextjs-shadcn, then run npm install. Finish by running npx convex dev --once to provision a deployment and push the initial code.

How do I add Convex to an existing Next.js app?▼

Install the convex package, create a ConvexClientProvider component wrapping ConvexProvider with a ConvexReactClient, and add it to your root layout. Run npx convex dev --once to write NEXT_PUBLIC_CONVEX_URL to .env.local automatically.

Which Convex template should I use for a new app?▼

Use react-vite-shadcn for simple apps or nextjs-shadcn when you need SSR or API routes. Auth-focused templates include react-vite-clerk-shadcn, nextjs-clerk, and nextjs-convexauth-shadcn, while bare provides only the backend.

Does Convex work without logging in or creating an account?▼

Yes, setting CONVEX_AGENT_MODE=anonymous or running in a non-TTY environment provisions a local anonymous backend on 127.0.0.1 with no browser login. The deployment persists under ~/.convex/ and can be claimed later via npx convex login.

Why should the agent not run npx convex dev in the foreground?▼

The npx convex dev watcher is a long-running process that never exits, blocking the agent. Use npx convex dev --once for one-shot provisioning and validation, then let the user run npm run dev or start it in the background.

When should I not use the Convex quickstart workflow?▼

Skip it when the project already has Convex installed and a convex/ directory exists, since you can start building directly. Also use the convex-setup-auth skill instead if you only need to add authentication to an existing Convex app.