A npm script for generating all parts of react and redux web application.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
commands
docs
file_types
helpers
templates
test
.gitignore
.travis.yml
CODE_OF_CONDUCT.md
LICENSE
README.md
index.js
package.json
yarn.lock

README.md

React-Redux File Generator

npm version downloads license Build Status CircleCI

Code Triagers Badge dependencies Status devDependencies Status

This generator helps to create the necessary files for a react-redux application. It follows the file structure below. The frontend folder is stored at the root directory of the application.

Installation

npm install -g redux-file-gen

In order to create the terminal command redux, this package needs to be installed globally.

Usage

redux [command] [fileType] [options]

File structure

frontend
  |- actions
    |- <actionName>_actions.js
  |- components
    |- <componentName>
      |- <componentName>.jsx
      |- index.jsx
    |- app.jsx
    |- root.jsx
  |- reducers
    |- root_reducer.js
    |- <reducerName>_reducer.js
  |- store
    |- store.js
  |- util
    |- <utilName>_util.js
  |- <projectName>.jsx

Commands

Command Alias Function
generate g use the file generator
remove r remove the generated files
--help -h see available commands
--version -v see current package version

FileTypes

FileType Function
base <projectName> generate app.jsx, root.jsx, <projectName>.jsx, and store.js
action <name> [action1] [action2] ... generate <name>_actions.js with specified actions
component <name> [options] generate <name>.jsx and <name>_container.jsx
reducer <name> [action1] [action2] ... generate <name>_reducer.js
util <name> [util1] [util2] ... generate <name>_util.js with specified utils

Options

Option Alias Function
--functional -f create functional component
--no-container -nc do not create component container

For more details regard different types of files

Version notes

To see what features are added during each update, click here

Contributing

To request a feature or report an issue, click here.