convex-quickstart

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

Updated Apr 8, 2026
One-click install
npx skills add https://github.com/Noisemaker111/unofficialmarathon --skill convex-quickstart-noisemaker111
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: convex-quickstart
Source: https://github.com/Noisemaker111/unofficialmarathon/tree/main/packages/backend/.crush/skills/convex-quickstart
Command: npx skills add https://github.com/Noisemaker111/unofficialmarathon --skill convex-quickstart-noisemaker111

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires convex.

What problem does it solve? Setting up a Convex backend involves choosing templates, installing packages, wiring up providers, 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 or nextjs-shadcn. - Existing App Integration: Installs the convex package and wires up ConvexProvider for React, Next.js, Vue, Svelte, and other frameworks with the correct environment variable names. - Headless Agent Support: Runs anonymous local deployments via CONVEX_AGENT_MODE for cloud environments without browser login. - Use Case: You have an existing React + Vite app and want a realtime backend. The skill installs Convex, configures VITE_CONVEX_URL, wraps the app in ConvexProvider, and verifies a query/mutation round-trip. ## Quick Start Set up Convex for this project, scaffolding a new app or integrating into my existing frontend, then verify the connection 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 an existing React app?▼

Install the convex package with npm, run npx convex dev to create a deployment and generate the convex/ directory, then wrap your app root in ConvexProvider with a ConvexReactClient created at module scope using the VITE_CONVEX_URL environment variable.

How to create a new Convex project from scratch?▼

Run npm create convex@latest my-app -- -t react-vite-shadcn to scaffold a complete project with frontend, backend, and configuration wired together. Then run npm install and start npx convex dev to connect a deployment.

What environment variable does Convex use in Next.js vs Vite?▼

Vite apps use VITE_CONVEX_URL while Next.js uses NEXT_PUBLIC_CONVEX_URL. Remix uses CONVEX_URL and React Native uses EXPO_PUBLIC_CONVEX_URL. The npx convex dev command writes the correct variable to .env.local automatically.

Can I run Convex dev in a headless or cloud agent environment?▼

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

When should I not use the Convex quickstart flow?▼

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