generator-react-redux-spa

Opinionated React Redux spa scalfolding

#Poject is still in Alpha

What is this for?

This is a geneartor used to create scalable react-redux based apps. The dir structure is based on the Three Rules For Structuring (Redux) Applications written by Jack Hsu. I've been using this for a few projects and have enjoyed the convention and decided to try to adopt this at work. However, the amount of the boilerplate required gave me second thoughs. And then.... the idea of this project was born.

Who is this for

Anyone who wants setup a scalable react-redux application.

What this is not

This was created to lighten workload on developers at my work as we are trying out the directory structure. It is heavily opiniated. It is not meant to support every possible way of creating a react app. This is by no means a standard for react apps. There are certainly better ways to do this.

Problems with this generator

1. Front end only. I work in an environment that does not have javascript as a backend.
2. Boat load of dependencies you may or may not need. (I trust that able developers can remove them failry quickly)
3. yarn by default
4. I put my own .eslint config in here

Noted features

1. React Hot Loader
2. React Storybook
3. Redux dev tools compatible
4. Jest for tests

More docs needed

Installation

First, install Yeoman and generator-react-redux-spa using npm (we assume you have pre-installed node.js). Also install yarn

npm install -g yo
npm install -g generator-scalable-react-redux@alpha

Then generate your new project:

yo scalable-react-redux

generate a new module with in the project. This will hook up nav automatically

yo scalable-react-redux:module

Run app

yarn start

• visit app at [http://localhost:3000]

react-storybook

yarn storybook

• visit react-storybook at [http://localhost:6001]

Run test

yarn test:watch

Task List

• [ ] no tests what-so-ever
• [ ] looking into adding redux observables

Getting To Know Yeoman

• Yeoman has a heart of gold.
• Yeoman is a person with feelings and opinions, but is very easy to work with.
• Yeoman can be too opinionated at times but is easily convinced not to be.
• Feel free to learn more about Yeoman.

License

MIT © Alex Liang