Michael Bromley 3a7de838e8 chore(create): Add `dist` to gitignore 6 years ago
..
src 6b6b3e339d feat(create): Include a .gitignore file 6 years ago
templates 3a7de838e8 chore(create): Add `dist` to gitignore 6 years ago
.gitattributes 5fdeace799 fix(create): Add .gitattributes to prevent eol conversions 6 years ago
.gitignore 7c633860da feat: create @vendure/create package 6 years ago
.npmignore 7c633860da feat: create @vendure/create package 6 years ago
README.md 50cf54e9f8 docs: Update documentation for plugins & getting started 6 years ago
build.ts 7c633860da feat: create @vendure/create package 6 years ago
index.js 7c633860da feat: create @vendure/create package 6 years ago
package.json 92493b6cd7 chore: Publish v0.6.1 6 years ago
tsconfig.build.json 7c633860da feat: create @vendure/create package 6 years ago
tsconfig.json 9a5824c811 chore: Move common tsconfig setting to root 6 years ago

README.md

Vendure Create

A CLI tool for rapidly scaffolding a new Vendure server application. Heavily inspired by create-react-app.

Usage

Vendure Create requires Node.js v8.9.0+ to be installed.

To create a new project, you may choose one of the following methods:

npx

npx @vendure/create my-app

npx comes with npm 5.2+ and higher.

npm

npm init @vendure my-app

npm init <initializer> is available in npm 6+

Yarn

yarn create @vendure my-app

yarn create is available in Yarn 0.25+

It will create a directory called my-app inside the current folder.

Options

--use-npm

By default, Vendure Create will attempt to use Yarn to install all dependencies if it is available. You can override this and force it to use npm with the --use-npm flag.

--log-level

You can control how much output is generated during the installation and setup with this flag. Valid options are silent, info and verbose. The default is silent

Example:

npx @vendure/create my-app --log-level verbose