convex-quickstart

Scaffold Convex projects and wire ConvexProvider with environment variables.

1|1|Updated Apr 13, 2026
One-click install
npx skills add https://github.com/liminal-ai/liminal-build --skill convex-quickstart-liminal-ai
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: convex-quickstart
Source: https://github.com/liminal-ai/liminal-build/tree/main/.agents/skills/convex-quickstart
Command: npx skills add https://github.com/liminal-ai/liminal-build --skill convex-quickstart-liminal-ai

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Initializes a new Convex project from scratch or adds Convex to an existing app. Use this skill when starting a new project with Convex, scaffolding with npm create convex@latest, adding Convex to an existing React, Next.js, Vue, Svelte, or other frontend, wiring up ConvexProvider, configuring environment variables for the deployment URL, or running npx convex dev for the first time, even if the user just says "set up Convex" or "add a backend."

Core Features & Use Cases

  • Scaffolds a new Convex app with official templates (React, Next.js, Vue, Svelte) or a minimal Convex backend setup.
  • Wires ConvexProvider and environment variable configuration for a working local deployment.
  • Supports first-time dev with npx convex dev to create a deployment and generate generated types.

Quick Start

Scaffold a new Convex project with npm create convex@latest my-app -- -t react-vite-shadcn, then install dependencies and start the dev loop.

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 a Convex project with React or Next.js?

To set up a Convex project with React or Next.js, use the scaffolding command `npm create convex@latest` to apply official frontend templates, wire up ConvexProvider, and configure environment variables for a local deployment.

Can I add Convex to an existing Vue or Svelte frontend?

Yes, you can add Convex to an existing Vue or Svelte frontend by wiring up the ConvexProvider and configuring environment variables to connect your app to a new Convex backend deployment.

What is the best way to configure environment variables for a Convex deployment?

The best way to configure environment variables for a Convex deployment is during initial project setup, ensuring the deployment URL is correctly specified when wiring up the ConvexProvider for your local development session.

How do I start the Convex dev loop and generate types?

Start the Convex dev loop by running `npx convex dev` for the first time, which creates your deployment, connects the convex directory, and automatically generates the required TypeScript types for your frontend.

Does scaffolding a new Convex app require a specific frontend framework?

Scaffolding a Convex app does not require a specific frontend framework, supporting official templates for React, Next.js, Vue, Svelte, or a minimal backend setup to fit various frontend team workflows.