A Yeoman generator for React & Redux for projects vertically integrated.
Of those out there, the React and Redux templates have a horizontal structure for their projects.
This means all of your elements belong in the same folder, i.e. your components
go in a components folder.
This generator works for vertically integrated React and Redux projects. The
sub-generator will create modules for you with a smaller version of the
horizontal structure. Each module is self-contained, although there may be a
base that is common to everything else.
This repo is copied from React/Flux Vertical generator, which I'm de-comissioning in favor of this one.
For this generator to work, Yeoman must be globally installed.
npm install -g yoThen you can install this generator-react-redux-modules module. I do not maintain generator-react-redux.
npm install -g generator-react-redux-modulesCreates the base project. Loosely based off React-starter-kit.
yo react-redux-modulesThis will compile base files, including the Source, and Tools folders. (tests pending)
| Option | Description | Default |
|---|---|---|
-h, --help |
Print the generator's options and usage | |
--skip-cache |
Do not remember prompt answers | Default: false |
--skip-install |
Do not automatically install dependencies | Default: false |
The sub generators assumes you already have a project up and running. They are to help you through developing new modules, components, etc.
When you need to start creating new modules, simple use the sub-generator module.
yo react-redux-modules:module [options] <moduleName>Within the module sub-generator, the following default files are generated for you. Replace with your own module name.
| Option | Description | Default |
|---|---|---|
-h, --help |
Print the generator's options and usage | |
--skip-cache |
Do not remember prompt answers | Default: false |
--skip-install |
Do not automatically install dependencies | Default: false |
| Arguments | Description | Type | Required |
|---|---|---|---|
| moduleName | Name of the module | String | true |
The following command will generate the following:
yo react-redux-modules:module auth
# Generates the auth folder with all necessary filesIf you want to create a component other modules depend on, this sub-generator will create the files needed for you.
Within the component sub-generator, the following default files are generated for you. Replace #{CommonComponentName} with your own module name.
.
└── src
└── common
└── components
└── CommonComponentName
├── CommonComponentName.js
├── CommonComponentName.scss
└── package.json| Arguments | Description | Type | Required |
|---|---|---|---|
| componentName | Name of the module | String | true |
| componentRoot | Name of the module | String | true |
| Option | Description | Default |
|---|---|---|
-h, --help |
Print the generator's options and usage | |
--skip-cache |
Do not remember prompt answers | Default: false |
--skip-install |
Do not automatically install dependencies | Default: false |
--raw |
Use user input raw format for component name | Default: false |
The following command will generate the following:
yo react-redux-modules:component TextBox ./src/common/components --raw
# Generates the following:
.
└── src
└── common
└── components
└── TextBox
├── TextBox.js
├── TextBox.scss
└── package.jsonIf you want to generate an action test, for a known module, this sub-generator will help.
Within the component sub-generator, the following default files are generated for you.
Replace #{module} and #{action} with your own module and action names.
.
└── test
└── unit
└── module
└── actions
└── action.spec.js| Arguments | Description | Type | Required |
|---|---|---|---|
| module | Name of the module | String | true |
| action | Name of the action | String | true |
The following command will generate the following:
yo react-redux-modules:actionTests Analytics Partners
# Generates the following:
.
└── test
└── unit
└── Analytics
└── actions
└── Partners.spec.jsAnyone and everyone is welcome to contribute, however, if you decide to get involved, please take a moment to review the guidelines:
The code is available under the MIT license.
![greenkeeper[bot] avatar](https://avatars.githubusercontent.com/in/505?v=4 "greenkeeper[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent