convex-quickstart

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

Updated Jun 7, 2026
One-click install
npx skills add https://github.com/agnivon/viral_thread_generator --skill convex-quickstart-agnivon
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: convex-quickstart
Source: https://github.com/agnivon/viral_thread_generator/tree/main/.agents/skills/convex-quickstart
Command: npx skills add https://github.com/agnivon/viral_thread_generator --skill convex-quickstart-agnivon

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires convex.

What problem does it solve? Setting up a Convex backend involves scaffolding, provisioning a deployment, wiring environment variables, and connecting a frontend provider, which is error-prone when done manually. This Skill walks through the entire setup path so a working Convex project runs 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. - One-Shot Provisioning: Runs npx convex dev --once to provision an anonymous local deployment, push code, typecheck functions, and validate the schema in a single command. - Use Case: You have an existing Next.js app and want a reactive backend. The Skill installs Convex, adds the ConvexClientProvider to your root layout, provisions a local deployment, and verifies a query/mutation round-trip works. ## Quick Start Set up Convex for this project by scaffolding a new app or integrating it into my existing frontend, then 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 my-app -- -t react-vite-shadcn to scaffold a complete project with frontend, backend, and config wired together. Then run npm install and npx convex dev --once to provision a deployment and validate the code.

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

Install the convex package, create a ConvexClientProvider client component wrapping your root layout, and run npx convex dev --once. It writes NEXT_PUBLIC_CONVEX_URL to .env.local and generates typed code in convex/_generated.

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-ready variants include nextjs-clerk, nextjs-convexauth-shadcn, and react-vite-clerk-shadcn; bare provides backend only.

Does Convex work with frameworks other than React and Next.js?▼

Yes, Convex supports Vue, Svelte, React Native, TanStack Start, Remix, and Node.js without a frontend. Each framework has its own quickstart guide and environment variable naming convention, such as EXPO_PUBLIC_CONVEX_URL for React Native.

Why does npx convex dev not exit when I run it?▼

npx convex dev is a long-running file watcher that syncs code on save and never exits on its own. For a one-shot provisioning and validation run that exits cleanly, use npx convex dev --once instead.

When should I not use the Convex quickstart flow?▼

Skip it when the project already has Convex installed and a convex/ directory exists, since you can start building directly. For adding auth to an existing Convex app, use a dedicated auth setup flow instead of re-scaffolding.