README.md

Convex

This example demonstrates the Convex global state management framework.

Deploy your own

Deploy the example using Vercel:

How to use

Execute create-next-app with npm, Yarn, or pnpm to bootstrap the example:

npx create-next-app --example convex convex-app
# or
yarn create next-app --example convex convex-app
# or
pnpm create next-app --example convex convex-app

Run

npm run dev

to run next dev and a Convex file watcher at the same time. This command will log you into Convex, so you'll need to create a Convex account if this is your first project.

Once everything is working, commit your code and deploy it to the cloud with Vercel (Documentation).

Use npx convex deploy && npm run build as the build command and set the CONVEX_DEPLOY_KEY environmental variable in Vercel (Documentation).