Skip to content

Latest commit

 

History

History
49 lines (37 loc) · 1.63 KB

README.md

File metadata and controls

49 lines (37 loc) · 1.63 KB
Raw

(WIP)

An Angular-esque cli for React.

  • component generation with states
  • supports redux
  • supports sass
  • includes react-scripts

Installation

npm install -g partum-react

Quick Start

Can be pulled up using partum -h or partum --help.

Commands:
        -a, --action:     Create a new action in a redux enabled project. 
        -c, --component:  Create a new react component.
        -d, --docs:       Opens documentation(https://luchighwalker.github.io/partum-react/#/).
        -h, --help:       Displays this help message.
        -i, --init:       Initializes partum in a current react project directory.
        -v, --version:    Displays the current installed version of partum-react.

Usage:
 $ partum [project name]
 Creates a new react project with options (default):
          redux (false): Enables redux support.
          js (false): Uses the js file format instead of jsx.
          scss || sass (css): Uses scss or sass for stylesheets respectively.

 $ partum -c [component name] [state key]=[state value]
 Generates a new react component with options (default):
          -f, --func, --functional (false): Generates a functional component instead of a class component.
          [state key]=[state value]: Optional, adds states to the component.

 $ partum -a [action name] [action file] [reducer file]
 Generates a new action with the options (default):
          [action file] (action.js): Specifies which action folder to add the action.
          [reducer file] (reducer.js): Specifies which reducer file to add the action dispatch to.

Usage

Reference the docs