# r3-cli

Latest version **4.2.0** (published 2019-10-02) · MIT license · 0 weekly downloads

## Install

```sh
npm install r3-cli
pnpm add r3-cli
yarn add r3-cli
bun add r3-cli
```

Provides the command `r3-cli`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 4.2.0 |
| Published | 2019-10-02 |
| First published | 2018-03-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 11 |
| Unpacked size | 4.5 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | reginaldoMorais |
| Maintainers | reginaldomorais |
| Keywords | react, redux, react-router, code-generator |

## Links

- npm: https://www.npmjs.com/package/r3-cli
- Repository: https://github.com/reginaldoMorais/r3-cli
- Homepage: https://github.com/reginaldoMorais/r3-cli#readme
- Issues: https://github.com/reginaldoMorais/r3-cli/issues
- npm.io page: https://npm.io/package/r3-cli

## Dependencies (11)

- [add](https://npm.io/package/add.md) ^2.0.6
- [clui](https://npm.io/package/clui.md) ^0.3.6
- [yarn](https://npm.io/package/yarn.md) ^1.19.0
- [chalk](https://npm.io/package/chalk.md) ^2.4.2
- [clear](https://npm.io/package/clear.md) ^0.1.0
- [touch](https://npm.io/package/touch.md) ^3.1.0
- [figlet](https://npm.io/package/figlet.md) ^1.2.4
- [lodash](https://npm.io/package/lodash.md) ^4.17.15
- [fs-extra](https://npm.io/package/fs-extra.md) ^8.1.0
- [inquirer](https://npm.io/package/inquirer.md) ^7.0.0
- [minimist](https://npm.io/package/minimist.md) ^1.2.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

- 4.2.0 (latest) — 2019-10-02
- 4.1.3 — 2019-08-14
- 4.1.2 — 2019-08-14
- 4.1.1 — 2019-06-22
- 4.1.0 — 2019-06-22
- 4.0.1 — 2019-01-28
- 4.0.0 — 2019-01-27
- 3.0.6 — 2019-01-06
- 3.0.5 — 2018-10-26
- 3.0.4 — 2018-10-15
- 3.0.3 — 2018-10-15
- 3.0.2 — 2018-05-15
- 3.0.1 — 2018-05-09
- 3.0.0 — 2018-04-24
- 2.0.1 — 2018-04-04
- … 4 more at https://npm.io/package/r3-cli/versions

## README

<p align="center">
  <a href="https://github.com/reginaldoMorais/r3-cli-vscode-snippet">
    <img alt="r3-cli" src="https://image.ibb.co/cZZcUn/r3_cli_snippet_icons.png" width="244">
  </a>
</p>

# R3-CLI

Create React applications with server-side rendering using Redux and Router v4. Simple and very fast!

## Installation

Run the command below, to have the module installed globally:

```bash
npm install -g r3-cli
```

### For old structure

For the old structure please use R3-CLI version 3 or before.

```bash
npm install -g r3-cli@^3.0.6
```

## Usage

To see commands avaliable, run a single command with argument:

```bash
r3-cli --help
```

To create a new Project, run the command:

```bash
r3-cli
```

or

```bash
r3-cli -c my-app
```

It will create a directory called `my-app` inside the current folder.

You will found the initial Project structure:

```note
my-app
├── .gitignore
├── package.json
├── README.md
├── node_modules
└── source
    ├── actions
    │   └── IndexActions.js
    │
    ├── assets
    │   ├── fonts
    │   ├── images
    │   └── styles
    │
    ├── client
    │   ├── index.ejs
    │   ├── index.html
    │   └── index.js
    │
    ├── config
    │   ├── index.js
    │   ├── config.env.json
    │   └── response.status.json
    │
    ├── reducers
    │   └── IndexReducer.js
    │
    ├── server
    │   ├── excludesExtensions.js
    │   ├── index.js
    │   ├── server.js
    │   └── template.js
    │
    ├── views
    │   ├── web
    │   │   ├── components
    │   │   ├── controller
    │   │   ├── pages
    │   │   │   └── index
    │   │   │       ├── __test__
    │   │   │       ├── Index.js
    │   │   │       └── IndexContainer.js
    │   │   │
    │   │   ├── templates
    │   │   │   ├── In.js
    │   │   │   ├── Out.js
    │   │   │   └── PageNotFound.js
    │   │   │
    │   │   └── Imports.js
    │   │
    │   └── mobile (future feature)
    │
    ├── Reducers.js
    ├── Routes.js
    └── Store.js
```

## Running your new Project

Inside the newly created Project, you need to set a Node version:

### Requisite

**NVM**

To easily switch Node versions for your Project, You can use [NVM](https://github.com/creationix/nvm) command:

```bash
curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.8/install.sh | bash
source ~/.bashrc
nvm install
nvm use
```

### Running

Afterward you can run some built-in commands:

```bash
npm start
```

or

```bash
yarn start
```

Your Project is ready to be accessed. Your can run the command **npm ls** or **yarn ls** to view available commands.

## Creating a new Route

To create a new route on your Project run the command bellow:

```bash
r3-cli --route
```

A new route and view will automatically be created. It will be created the files:

./source/views/web/page/newView

```note
NewView.jsx
NewViewContainer.jsx
```

./source/actions

```note
NewViewActions.js
```

./source/reducers

```note
NewViewReducer.js
```

## So, enjoy the plugin and Thank you for use it!

[Reginaldo Morais](mailto:reginaldo.cmorais@gmail.com)

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