One-click install
npx skills add https://github.com/MichaelFrieze/riffatlas --skill convex-quickstart-michaelfrieze
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: convex-quickstart
Source: https://github.com/MichaelFrieze/riffatlas/tree/main/.agents/skills/convex-quickstart
Command: npx skills add https://github.com/MichaelFrieze/riffatlas --skill convex-quickstart-michaelfrieze

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Convex Quickstart solves the problem of getting a Convex backend running quickly so you can iterate on a working app instead of wrestling with setup and wiring.

Core Features & Use Cases

  • Project scaffolding and integration: Use official Convex templates to scaffold a new app or install Convex into an existing frontend.
  • Local development workflow: Connect to a Convex dev deployment, generate the convex/ directory, and keep the dev loop running with npx convex dev.
  • Correct framework wiring: Configure the Convex provider/client and the required environment variables for Vite, Next.js, Remix, or React Native.

Quick Start

Tell me whether you are starting a new app or adding Convex to an existing project, and then I will guide you through scaffolding or installation, configuring the right provider and env vars, and verifying a first query/mutation 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 backend for a React or Next.js app?

To set up a Convex backend, install the convex package, wrap your app in a Convex provider, and set the CONVEX_URL environment variable to connect your React or Next.js frontend to the dev deployment.

What is the local development workflow for running a Convex backend?

The Convex local development workflow involves running npx convex dev to connect to a dev deployment, generating the convex/ directory, and validating _generated types alongside your queries and mutations.

Can I add Convex to an existing frontend project or do I need a template?

You can add Convex to an existing project by installing the package and wiring the client provider, or scaffold a new app from official Convex templates to get a working fullstack setup immediately.

Does Convex work with Vite, Remix, and React Native frameworks?

Yes, Convex integrates with Vite, Remix, and React Native by configuring the correct Convex client provider and setting the required environment variables for your specific framework.

Why do my Convex _generated types fail to validate during the dev loop?

Convex _generated types fail to validate when the dev deployment is not running or schema changes are uncommitted, so keep the npx convex dev loop active to regenerate types and sync queries.

Do I need to set the CONVEX_URL environment variable for local Convex development?

Yes, setting the CONVEX_URL environment variable is required to wire your Convex client provider to the correct dev deployment and successfully execute queries and mutations.