skills.rest
hpark0011
hpark0011COMMUNITY
Explore all skills by this author →
GitHub

convex-quickstart

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

Updated Apr 17, 2026
Search Tags:#react#backend#scaffolding#setup#nextjs#convex#realtime database
One-click install
npx skills add https://github.com/hpark0011/mirror --skill convex-quickstart-hpark0011
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: convex-quickstart
Source: https://github.com/hpark0011/mirror/tree/main/.agents/skills/convex-quickstart
Command: npx skills add https://github.com/hpark0011/mirror --skill convex-quickstart-hpark0011

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires convex, and includes assets (resource) components.

What problem does it solve? Setting up a Convex backend involves scaffolding, provisioning a deployment, wiring environment variables, and connecting a frontend provider. This Skill walks an AI agent through the entire setup so a working Convex project is running in minutes without manual configuration errors. ## Core Features & Use Cases - New Project Scaffolding: Creates complete projects with npm create convex@latest using templates for React, Next.js, Clerk auth, Convex Auth, and more. - 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. - Automated Provisioning & Validation: Runs npx convex dev --once to provision an anonymous local deployment, push code, typecheck functions, 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, wraps your root layout with the provider, provisions a local deployment, and verifies a query/mutation round-trip works. ## Quick Start Set up Convex for this project, scaffolding a new app or integrating 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 with a project name and template flag, such as npm create convex@latest my-app -- -t react-vite-shadcn. Then run npm install and npx convex dev --once to provision a local deployment and validate the generated code.

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

Install the convex package, create a ConvexReactClient at module scope in a client component, and wrap your root layout with ConvexProvider. Run npx convex dev --once to write NEXT_PUBLIC_CONVEX_URL to .env.local and push your backend code.

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

Use react-vite-shadcn for simple React apps or nextjs-shadcn when you need SSR or API routes. Templates with Clerk, Convex Auth, or Lucia are available when authentication is required, and bare provides a backend-only setup.

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

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

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

npx convex dev is a long-running watcher that never exits, so running it in the foreground blocks the agent. Instead, run npx convex dev --once for one-shot validation, and let the user start the watcher or run 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.

Related Skills

Explore More Software Engineering Skills→
agnivonagnivon

convex-quickstart

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

Community
Intermediate
tomrfordtomrford

convex-quickstart

Design, deploy, and seed a Convex backend with schema, authentication, and CRUD operations.

Community
Intermediate
openclawopenclaw
9.4k

convex-add

Adds backend capabilities to an existing Convex app via a served capability catalog.

Official
Intermediate
sitharaj88sitharaj88
1

db-supabase

Generate Supabase backend configurations including schemas, RLS policies, and Edge Functions.

Community
Advanced