create-convex

0.0.9 • Public • Published

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-clerk-shadcn
  • nextjs-lucia-shadcn
  • nextjs-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'

Readme

Keywords

none

Package Sidebar

Install

npm i create-convex

Homepage

convex.dev

Weekly Downloads

37

Version

0.0.9

License

Apache-2.0

Unpacked Size

81.2 kB

Total Files

5

Last publish

Collaborators

  • ldanilek
  • rakeebh-convex
  • sshader
  • preslavle
  • xixixao
  • arnoldtrakh
  • ballingt
  • emmaling27
  • ikhare
  • sujayakar
  • nipunn
  • gautamg795
  • cowling