Skip to content
Branch: master
Find file History
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
src docs: Update documentation for plugins & getting started Apr 5, 2019
templates feat(create): Update config with latest email-plugin API changes Apr 16, 2019
.gitignore
.npmignore
README.md docs: Update documentation for plugins & getting started Apr 5, 2019
build.ts feat: create @vendure/create package Apr 4, 2019
index.js feat: create @vendure/create package Apr 4, 2019
package.json
tsconfig.build.json feat: create @vendure/create package Apr 4, 2019
tsconfig.json feat: create @vendure/create package Apr 4, 2019

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
You can’t perform that action at this time.