next.js/examples/convex/README.md

Convex

This example demonstrates the Convex backend platform.

Deploy your own

How to use

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

npx create-next-app --example convex convex-app

yarn create next-app --example convex convex-app

pnpm create next-app --example convex convex-app

While developing:

npm run dev

This command runs next dev and convex dev 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 --cmd 'npm run build' as the build command and set the CONVEX_DEPLOY_KEY environmental variable in Vercel (Documentation).