react-cli
![Build Status](https://travis-ci.org/99xt/react-cli.svg?branch=master)
![Join the chat at https://gitter.im/react-cli-99xt/Lobby](https://badges.gitter.im/react-cli-99xt/Lobby.svg)
Scaffolding tool for React
react-cli is a command line interface which brings smooth developer experience (DX) for React devs. react-cli provides a better way to generate react projects with react-boilerplate. With this tool it's possible to continue generating boilerplate code with heavy customizations once a project is initiated.
Install
$ npm install -g @99xt/react-cli
Usage
react init [name]
alias: i
name
Project name.
Options
-l
Add eslint configuration.
react generate component [module] [component]
alias: g
module
Module name where the react component should be placed within. (Subdirectory within components directory)
component
React component name.
react generate test [module] [component]
alias: g
Create React component.
module
Module name where the test file should be placed within. (Subdirectory within tests directory)
component
Test file name.
react view -c -t
alias: v
View react components and test files.
Options
react config [key] [value]
alias: c
Change configuration in .reactclirc
.
key
Key for configuration
example: client
value
Value for configuration
example: src
(source directory)
Configuring existing projects
To use react-cli in existing React project navigate to directory where React components are created.
Create react-cli configuration file, .reactclirc
(similar to .babelrc
). Add configuration in key value pairs.
{
"client": "src"
}
This specifies that React components are placed in src/components
directory.
Features
- Initiate React projects
- Create React components
- Create test files
- Interactive view of the component structure
References
Contributor guidelines
- Fork the repository.
- Clone the forked repository.
- Create your own branch.
- Create tests and make sure tests pass on travis.
- Create a pull request with changes made.
For more information refer CONTRIBUTING.md
License
MIT © 99XT