# @dopt/create-example

> A CLI for generating Dopt example projects

Latest version **0.3.1** (published 2024-03-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install @dopt/create-example
pnpm add @dopt/create-example
yarn add @dopt/create-example
bun add @dopt/create-example
```

Provides the command `create-example`.

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.1 |
| Published | 2024-03-11 |
| First published | 2023-04-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=16.0.0 |
| Dependencies | 1 |
| Unpacked size | 55.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | kseth, alexchantastic, pankaj-avhad-dopt, chasebish, joemckenney |

## Links

- npm: https://www.npmjs.com/package/@dopt/create-example
- Repository: https://github.com/dopt/odopt
- Homepage: https://github.com/dopt/odopt/tree/main/packages/%40dopt/create-example
- Issues: https://github.com/dopt/odopt/issues
- npm.io page: https://npm.io/package/@dopt/create-example

## Dependencies (1)

- [minimist](https://npm.io/package/minimist.md) 1.2.8

## Recent versions

- 0.3.1 (latest) — 2024-03-11
- 0.3.0 — 2023-09-11
- 0.2.1 — 2023-08-16
- 0.2.0 — 2023-08-15
- 0.1.0 — 2023-08-07
- 0.0.4 — 2023-05-04
- 0.0.3 — 2023-05-03
- 0.0.2 — 2023-05-02
- 0.0.1 — 2023-05-01
- 0.0.0-alpha.0 — 2023-04-27

## README

# @dopt/create-example

A CLI for scaffolding [Dopt](https://www.dopt.com/) example projects.

## Requirements

[Node.js](https://nodejs.org/) >= v16.0.0

## Usage

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

```sh
# 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:

```sh
# 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:

```sh
# 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`](./templates) directory for the list of templates.

- [`react`](./templates/react)
- [`react-ts`](./templates/react-ts)

---
_Source: https://npm.io/package/@dopt/create-example · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._