npm.io
0.3.1 • Published 2 years agoCLI

@dopt/create-example

Licence
MIT
Version
0.3.1
Deps
1
Size
56 kB
Vulns
0
Weekly
0

@dopt/create-example

A CLI for scaffolding Dopt example projects.

Requirements

Node.js >= v16.0.0

Usage

Run the following command depending on what package manager you use:

# npm
npm create @dopt/example

# Yarn
yarn create @dopt/example

# pnpm
pnpm create @dopt/example

And then follow the instructions printed in your terminal.

You can specify the path to initialize the example project and the template to use by running:

# npm
npm create @dopt/example path-to-project -- --template template-name

# Yarn
yarn create @dopt/example path-to-project --template template-name

# pnpm
pnpm create @dopt/example path-to-project --template template-name

Some templates can also take in arguments for enhanced functionality:

# npm
npm create @dopt/example -- --template react --templateArgs arg1,arg2

# Yarn
yarn create @dopt/example --template react --templateArgs arg1,arg2

# pnpm
pnpm create @dopt/example --template react --templateArgs arg1,arg2

Templates

See the templates directory for the list of templates.