Skip to content

vergekit/create-vergekit

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

create-vergekit

Create a new VergeKit app.

npm create vergekit@latest my-app

Cloudflare Workers + D1 remains the default. Select a preset explicitly with either supported flag form:

npm create vergekit@latest my-app -- --preset node-mysql
npm create vergekit@latest my-app -- --preset=node-mysql

Use the current directory:

npm create vergekit@latest .

What It Does

  • Downloads a tagged vergekit/vergekit release from GitHub.
  • Uses the latest GitHub release for npm create vergekit@latest.
  • Uses matching tag vX.Y.Z when you install create-vergekit@X.Y.Z.
  • Applies and validates the selected preset in a temporary staging directory.
  • Updates the generated app's package and lockfile root names from the target folder.
  • Copies the staged project into the target only after composition succeeds.
  • Prints the next setup commands.

The target directory must be empty, except for common metadata files such as .git, .gitkeep, .DS_Store, and Thumbs.db.

Development

npm install
npm test

Run the CLI locally:

node ./bin/create-vergekit.js my-app

Check the npm package contents before publishing:

npm pack --dry-run

About

Utility to create new Verge Kit apps via `npm create`

Resources

License

Stars

0 stars

Watchers

0 watching

Forks

Packages

 
 
 

Contributors