# create-react-ui

> create react component ui

Latest version **0.1.12** (published 2019-12-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install create-react-ui
pnpm add create-react-ui
yarn add create-react-ui
bun add create-react-ui
```

Provides the command `create-react-ui`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.12 |
| Published | 2019-12-06 |
| First published | 2019-09-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 7 |
| Unpacked size | 32.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | soberz |
| Maintainers | soberz |
| Keywords | cru, create-react-ui, react, component, ui, library, cli |

## Links

- npm: https://www.npmjs.com/package/create-react-ui
- Repository: https://github.com/YSMJ1994/create-react-ui
- npm.io page: https://npm.io/package/create-react-ui

## Dependencies (7)

- [chalk](https://npm.io/package/chalk.md) ^2.4.2
- [cli-step](https://npm.io/package/cli-step.md) ^1.0.2
- [fs-extra](https://npm.io/package/fs-extra.md) ^8.1.0
- [inquirer](https://npm.io/package/inquirer.md) ^7.0.0
- [commander](https://npm.io/package/commander.md) ^3.0.1
- [cli-spinner](https://npm.io/package/cli-spinner.md) ^0.2.10
- [download-git-repo](https://npm.io/package/download-git-repo.md) ^2.0.0

## Alternatives

- [@progress/kendo-ooxml](https://npm.io/package/@progress/kendo-ooxml.md) — 152.1K weekly downloads
- [@progress/kendo-react-ripple](https://npm.io/package/@progress/kendo-react-ripple.md) — 8.0K weekly downloads
- [@progress/kendo-react-orgchart](https://npm.io/package/@progress/kendo-react-orgchart.md) — 4.3K weekly downloads
- [@praxisui/dynamic-fields](https://npm.io/package/@praxisui/dynamic-fields.md) — 2.4K weekly downloads
- [@progress/kendo-vue-listbox](https://npm.io/package/@progress/kendo-vue-listbox.md) — 932 weekly downloads

## Recent versions

- 0.1.12 (latest) — 2019-12-06
- 0.1.11 — 2019-10-22
- 0.1.10 — 2019-10-22
- 0.1.9 — 2019-10-17
- 0.1.8 — 2019-10-17
- 0.1.7 — 2019-10-17
- 0.1.6 — 2019-10-17
- 0.1.5 — 2019-10-17
- 0.1.4 — 2019-10-17
- 0.1.3 — 2019-10-17
- 0.1.2 — 2019-10-17
- 0.1.1 — 2019-10-14
- 0.1.0 — 2019-10-14
- 0.0.2 — 2019-09-20
- 0.0.1 — 2019-09-17

## README

# create-react-ui

The cli to create a react component library project.

## Quick Overview

```bash
yarn create react-ui my_library_app
cd my_library_app
yarn start
```

## Creating an React Component Library project

### npx

```bash
npx create-react-ui my_library_app
```

_([npx](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b) comes with npm 5.2+ and higher, see [instructions for older npm versions](https://gist.github.com/gaearon/4064d3c23a77c74a3614c498a8bb1c5f))_

### npm

```bash
npm init react-ui my_library_app
```

_`npm init <initializer>` is available in npm 6+_

### yarn

```bash
yarn create react-ui my_library_app
```

_`yarn create` is available in Yarn 0.25+_

It will create a directory called `my_library_app` inside the current folder.<br> Inside that directory, it will generate the initial project structure and install the transitive dependencies:

```
my-app
├── cru.config.js
├── README.md
├── node_modules
├── package.json
├── .env.production
├── .gitignore
├── public
│   ├── favicon.ico
│   ├── index.html
├── components
│   ├── Button
│   │   ├── index.(jsx|tsx)
│   │   ├── index.md
│   │   ├── demo
│   │   │   ├── basic.md
│   │   │   └── basic2.md
│   │   └── style
│   │       └── index.scss
│   ├── common
│   │   └── index.scss
│   └── style
│       ├── index.scss
│       ├── colors
│       │   └── index.scss
│       ├── mixins
│       │   └── index.scss
│       └── themes
│           └── default.scss
├── doc
│   ├── quickStart.md
│   └── test.md
└── libraryStatic
    ├── LICENSE
    └── README.md

```

Once the installation is done, you can open your project folder:

```sh
cd my_library_app
```

Inside the newly created project, you can run some built-in commands:

### `npm start` or `yarn start`

Runs the doc app in development mode.<br> Open [http://localhost:3000](http://localhost:3000) to view it in the browser.

The page will automatically reload if you make changes to the code.<br>

### `npm run build` or `yarn build`

Builds the doc and the library for production to the `build-doc` and `build-library` folder.<br> It correctly bundles React UI Library Document in production mode and optimizes the build for the best performance. It will correctly build your project into a releasable UI component library

The doc build is minified and the filenames include the hashes.<br> Your doc is ready to be deployed! Your library is ready to be deployed!

### `npm run build-doc` or `yarn build-doc`

Just bundles the document in production mode

### `npm run build-library` or `yarn build-library`

Just bundles the React UI library in production mode

### `npm run eject` or `yarn eject`

If you want complete control over the build details

**Note: this is a one-way operation. Once you `eject`, you can’t go back!**

## License

Create React UI is open source software [licensed as MIT](https://github.com/YSMJ1994/create-react-ui/blob/master/LICENSE).

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