create-convex

Scaffolding Your First Convex Project

$ npm create convex@latest

Then follow the prompts!

You can also directly specify the project name and the template you want to use via additional command line options. For example, to scaffold a Convex project with no client, run:

npm create convex@latest my-app -- -t bare

-t is a shorthand for --template

Currently supported template presets include:

• bare
• nextjs-shadcn
• nextjs-clerk
• nextjs-convexauth-shadcn
• nextjs-lucia-shadcn
• react-vite-clerk-shadcn
• react-vite-shadcn

You can use . for the project name to scaffold in the current directory:

npm create convex@latest .

You can use any repository on GitHub as a template by providing the owner and repo names:

npm create convex@latest my-app -- -t thomasballinger/convex-clerk-users-table

optionally with a branch name:

npm create convex@latest my-app -- -t 'thomasballinger/convex-clerk-users-table#branch'

Developing

To work on this repo, make changes then bun build which will output to ./dist then bun run start to run it with bun or X run build where X is your package manager of choice.