convex-quickstart

Scaffold Convex projects and wire ConvexProvider into frontend applications.

Updated Apr 3, 2026
One-click install
npx skills add https://github.com/ScriptKitKat/TamaGoosie --skill convex-quickstart-scriptkitkat
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: convex-quickstart
Source: https://github.com/ScriptKitKat/TamaGoosie/tree/main/convex/.agents/skills/convex-quickstart
Command: npx skills add https://github.com/ScriptKitKat/TamaGoosie --skill convex-quickstart-scriptkitkat

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Convex Quickstart eliminates the tedious setup steps to start a Convex project or add Convex to an existing frontend, getting you from zero to a working dev loop quickly.

Core Features & Use Cases

  • Scaffolds new Convex projects with npm create convex@latest
  • Wires ConvexProvider into popular frontends (React, Next.js, Vue, Svelte)
  • Configures environment variables for deployment URL
  • Runs dev loop with npx convex dev and generates convex/ directory
  • Supports adding Convex to existing apps and offers agent-mode guidance

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.

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 React or Next.js app?

To add Convex to an existing React or Next.js app, you wire the ConvexProvider into your frontend and configure the deployment URL environment variables. This generates the convex/ directory and connects your application to the backend, enabling a live dev loop.

Can I use Convex with Vue or Svelte frontend frameworks?

Yes, you can use Convex with Vue, Svelte, and other frameworks. The scaffolding workflow supports wiring the ConvexProvider and configuring environment variables across these popular frontend platforms to establish your backend connection and start your dev loop.

What is the best way to scaffold a new Convex project from scratch?

The best way to scaffold a new Convex project is running npm create convex@latest. This initiates the template selection, configures environment variables, and sets up the convex/ directory to accelerate your project setup and get you to a working dev loop.

How do I start the Convex dev loop after wiring my frontend?

You start the Convex dev loop by running npx convex dev after wiring your frontend provider. This command generates the local convex/ directory, establishes your backend connection, and enables live development synchronization for your application.

Do I need to manually configure environment variables for my Convex deployment?

You need to configure environment variables for your Convex deployment URL, but the scaffolding process automates the provider wiring. This ensures your frontend application correctly targets the active backend deployment during local development and agent-mode operations.

Why use a Convex quickstart template instead of manual backend setup?

Using a Convex quickstart template eliminates tedious setup steps by providing self-contained workflows for scaffolding and integration. It accelerates your path from zero to a working dev loop across multiple frontend frameworks without manual configuration errors or provider wiring mistakes.