convex-quickstart
Set up a Convex backend in seconds
Getting started with Convex backend development requires multiple setup steps including scaffolding, provider configuration, and environment setup. This skill automates the project setup process for new and existing applications.
Download the skill ZIP
Upload in Claude
Go to Settings → Capabilities → Skills → Upload skill
Toggle on and start using
Test it
Using "convex-quickstart". Set up Convex for a new React project with the bare template
Expected outcome:
Project scaffolded successfully. Run 'npm install' in the my-app directory, then run 'npx convex dev' to start. The Convex deployment URL will be written to .env.local automatically. Created convex/schema.ts and convex/_generated/ types.
Using "convex-quickstart". Add Convex to my existing Vite React app
Expected outcome:
Installed convex package. Created ConvexProvider wrapper with ConvexReactClient using VITE_CONVEX_URL. Add CONVEX_URL=your-deployment-url to your .env.local file. Run 'npx convex dev' to connect to a deployment.
Security Audit
Low RiskEvaluated 125 static findings across 349 lines in 2 files. All major findings are false positives or expected patterns for a legitimate scaffolding tool. The skill contains npm scaffolding commands (expected), references .env.local for configuration (standard Convex setup), and documentation URLs. No malicious intent or credential exfiltration patterns detected.
Risk Factors
⚙️ External commands (16)
📁 Filesystem access (1)
🔑 Env variables (10)
Quality Score
What You Can Build
Start a new fullstack project with Convex
Quickly scaffold a complete Convex project with React, Next.js, or other frontend frameworks using official templates with all configuration wired together.
Add Convex backend to an existing app
Integrate Convex into a React, Next.js, Vue, Svelte, or other existing frontend by installing the package, configuring the provider, and setting up environment variables.
Set up Convex in CI or headless environments
Configure Convex for cloud agents or continuous integration using anonymous mode that avoids interactive browser authentication.
Try These Prompts
Set up a new Convex project. I want to use React with Vite and Tailwind CSS.
Add Convex backend to my existing Next.js application. I've already run npm install.
I need a working Convex backend as fast as possible for a prototype. Use the bare template.
Create a new Convex project with Next.js, shadcn/ui components, and Clerk authentication pre-configured.
Best Practices
- Let users run 'npx convex dev' themselves to handle browser-based OAuth authentication
- Use the react-vite-shadcn template as the default for new projects unless specified otherwise
- Create ConvexReactClient at module scope, not inside components, to avoid re-creating clients on every render
Avoid
- Do not scaffold inside an existing directory with files - it may overwrite existing code
- Do not run 'npx convex dev' directly in an agent - it requires interactive browser login
- Do not skip the npm install step - the scaffolding tool creates files but does not install dependencies