React-scaffolder NPM

react-scaffolder

Scaffolding tool for React

react-scaffolder is a command line interface which brings smooth developer experience (DX) for React devs. react-scaffolder 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 react-scaffolder

Quick Start

Quickest way to get up and running with react-scaffolder

Install the CLI - $ npm install -g react-scaffolder
Initiate a project - $ react init awesome-project && cd awesome-project
Install dependencies - $ npm install
Run the build - $ npm run build && npm start
Instantly create React components - $ react g component feed footer
Check with interactive view - $ react v -c

Usage

react init name

alias: i

name

Project name.

Options

-l Add eslint configuration.

react generate component module

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

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

-c View React components file directory.
-t View tests file directory.

react config key

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.