react-starter-kit-cli-cars
Version:
cli companion to react-starter-kit
85 lines (65 loc) • 2.05 kB
Markdown
#rsk-cli
##Install
Install via npm
```
npm install -g react-starter-kit-cli
```
##Quickstart
Quickly scaffolds out code for a front-end project/back-end project or both. By
default the front-end boilerplate used is [react-starter-kit](https://github.com/esayemm/react-starter-kit)
and the back-end boilerplate is [node-server-starter](https://github.com/esayemm/node-server-starter).
```
rsk-cli webapp helloworld --git --npm
// will result in this
.
└── helloworld
├── client
│ ├── config
│ ├── gulpfile.js
│ ├── node_modules
│ ├── package.json
│ ├── readme.md
│ ├── src
│ ├── webpack.config.dev.js
│ └── webpack.config.prod.js
└── server
├── config.js
├── index.js
├── models
├── node_modules
├── package.json
├── readme.md
├── routes
├── scripts
├── server.js
├── services
└── test
12 directories, 10 files
```
##Overview
Simple cli companion for [react-starter-kit](https://github.com/esayemm/react-starter-kit)
and [node-server-starter](https://github.com/esayemm/node-server-starter).
```
Usage: rsk-cli <command>
commands:
client <name> [--git|npm]
creates folder <name> and scaffolds client files,
--git init empty git repo and first commit
--npm runs npm install
comp <name>
scaffold files in src/components/<name>
note: only run this inside client dir
container <name>
scaffold files in src/containers/<name>
note: only run this inside container dir
server <name> [--git|npm]
create folder <name> with scaffold node server
--git init empty git repo and first commit
--npm runs npm install
update
update templates used to scaffold
webapp <name> [--git|npm]
creates folder <name> and scaffolds client and server folders,
--git init empty git repo and first commit
--npm runs npm install
```