# @qiwi/create-project

> Scaffold new QIWI projects with a CLI helper

Latest version **2.0.0** (published 2019-01-10) · MPL-2.0 license · 0 weekly downloads

## Install

```sh
npm install @qiwi/create-project
pnpm add @qiwi/create-project
yarn add @qiwi/create-project
bun add @qiwi/create-project
```

Provides the command `create-project`.

## Health

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

Positive: no vulnerabilities; high maintenance score.

Warnings: low downloads; no types; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2019-01-10 |
| First published | 2018-05-16 |
| Weekly downloads | 0 |
| License | MPL-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | ^8.10 \|\| >=10 |
| Dependencies | 8 |
| Unpacked size | 20.1 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Oleg Orlov |
| Maintainers | antongolub, khromushkin, lab009, qiwibot, secondtonone |
| Keywords | qiwi, neutrino, create, project, app, library, react, node |

## Links

- npm: https://www.npmjs.com/package/@qiwi/create-project
- Repository: https://github.com/qiwi/neutrino-presets/tree/master/packages/create-project
- Homepage: https://github.com/qiwi/neutrino-presets/tree/master/packages/create-project#readme
- Issues: https://github.com/qiwi/neutrino-presets/issues
- npm.io page: https://npm.io/package/@qiwi/create-project

## Dependencies (8)

- [chalk](https://npm.io/package/chalk.md) ^2.4.2
- [yargs](https://npm.io/package/yargs.md) ^12.0.5
- [fs-extra](https://npm.io/package/fs-extra.md) ^7.0.1
- [deepmerge](https://npm.io/package/deepmerge.md) ^3.0.0
- [command-exists](https://npm.io/package/command-exists.md) ^1.2.8
- [yeoman-generator](https://npm.io/package/yeoman-generator.md) ^3.2.0
- [yeoman-environment](https://npm.io/package/yeoman-environment.md) ^2.3.4
- [javascript-stringify](https://npm.io/package/javascript-stringify.md) ^1.6.0

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 2.0.0 (latest) — 2019-01-10
- 1.1.0 — 2018-07-17
- 1.0.2 — 2018-06-07
- 1.0.1 — 2018-06-04
- 1.0.1-beta.0 — 2018-06-04
- 1.0.0 — 2018-05-16

## README

# Scaffold a QIWI Project

Neutrino can help you quickly start new projects by scaffolding your initial project structure.
`@qiwi/create-project` uses middleware and presets behind the scene to build projects.

## Getting Started

Run the following command to start the process. Substitute `<directory-name>` with the directory name you wish to create for this project.

### Yarn

```bash
❯ yarn create @qiwi/project <directory-name>
```

_Note: The `create` command is a shorthand that helps you do two things at once. See the [Yarn create docs](https://yarnpkg.com/lang/en/docs/cli/create) for more details._

### npm/npx

```bash
❯ npx @qiwi/create-project <directory-name>
```

## Available Projects

`@qiwi/create-project` presently offers a scaffolding project to build an application, a library,
or components. Depending on the project type, the CLI helper may offer different flavors
of that project to scaffold. Each project type harnesses the power of middleware or presets to configure itself.

| Project | Project Type |
| --- | --- |
| React | Application |
| Web | Application |
| Node.js | Application |
| Web | Library |
| React Components | Components |

## Test Runners

If you wish to use a test runner, `@qiwi/create-project` will offer to set one up for you during
the scaffolding phase.

| Test Runner | Middleware |
| --- | --- |
| Jest | [`@neutrinojs/jest`](https://neutrino.js.org/packages/jest) |
| Mocha | [`@neutrinojs/mocha`](https://neutrino.js.org/packages/mocha) |

Be sure to check out the test runner preset to get more information on its features and how files should be named.

## Customization

No two JavaScript projects are ever the same, and as such there may be times when you will need to make modifications
to the way your Neutrino presets are building your project. Neutrino provides a mechanism to augment presets and
middleware in the context of a project without resorting to creating and publishing an entirely independent preset.
To override the build configuration, start with the documentation
on [customization](https://neutrino.js.org/customization).

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