create-vike icon indicating copy to clipboard operation
create-vike copied to clipboard

Generates Vike application boilerplate

Vike Project Generator

Generates Vike application boilerplate

Usage

create-vike [options] <output-dir>

Arguments:
  output-dir                   Output directory

Options:
  -V, --version                output the version number
  -f, --framework <framework>  Frontend framework (choices: "react", "vue")
  -l, --language <language>    Programming language (choices: "js", "ts")
  -h, --help                   display help for command

How it works

  • Generates TypeScript and JavaScript files from the templates in input-files via detype.
  • Copies files from files/<language>/<feature> where:
    • <language> is shared, ts, or js
    • <feature> is any combination of vike (default), react, vue, and client-router combined with a plus sign
  • Configuration files (package.json, tsconfig.json, and vite.config.{js,ts}) are generated programmatically.
  • Boilerplate package versions are kept in src/config-generators/package-versions.json, check-deps.mjs can be used to review package updates.

TODO

  • Add integration tests
  • Create an interactive frontend
  • Resolve user's default prettier config if any and use it instead of the default