convex-quickstart

Scaffold Convex projects or integrate Convex into existing frontends.

Updated Dec 23, 2021

Search Tags:#frontend #backend #scaffold #setup #convex #dev-loop

Ready to run

npx skills add https://github.com/dvakatsiienko/bytes --skill convex-quickstart-dvakatsiienko

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: convex-quickstart
Source: https://github.com/dvakatsiienko/bytes/tree/main/apps/x-com-chat/.agents/skills/convex-quickstart
Command: npx skills add https://github.com/dvakatsiienko/bytes --skill convex-quickstart-dvakatsiienko

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill speeds up starting a Convex project or adding Convex to an existing frontend, reducing setup friction and time-to-first-deploy.

Core Features & Use Cases

Scaffolds a brand-new Convex project with npm create convex@latest or integrates Convex into an existing React, Next.js, Vue, Svelte, or other frontend.
Wires up ConvexProvider and configures environment variables for the deployment URL.
Runs npx convex dev to establish a development loop and a local deployment for iterative development.

Quick Start

Decide whether you are starting a new project or adding Convex to an existing app, then scaffold with npm create convex@latest and follow the prompts to install dependencies and run the development loop.

Frequently Asked Questions about convex-quickstart

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

FAQPage Schema

How do I add Convex to an existing frontend project?▼

Yes, the setup supports integrating Convex into an existing React, Next.js, Vue, or Svelte frontend by wiring up ConvexProvider and configuring environment variables for the deployment URL.

How do I scaffold a new Convex backend project from scratch?▼

Scaffold a new Convex project using npm create convex@latest, follow the prompts to install dependencies, and run npx convex dev to initialize the persistent development loop and populate the convex directory with generated types.

What environment variables and configuration does Convex setup require?▼

Convex setup requires configuring environment variables for the deployment URL, which the persistent dev loop writes to .env.local, and the template-based scaffold enforces specific environment variable names per framework.

Does Convex work with Vue and Svelte frameworks or just React?▼

Convex works with React, Next.js, Vue, and Svelte frontends. The scaffold enforces template-based setup with environment variable names configured specifically per framework.

Why does npx convex dev need to run continuously during development?▼

Running npx convex dev establishes a persistent development loop that provisions a local deployment, writes deployment URLs to .env.local, and populates the convex directory with generated types for iterative development.