Opinionated React Redux spa scalfolding
#Poject is still in Alpha
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.
Anyone who wants setup a scalable react-redux application.
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.
- Front end only. I work in an environment that does not have javascript as a backend.
- Boat load of dependencies you may or may not need. (I trust that able developers can remove them failry quickly)
- yarn by default
- I put my own .eslint config in here
- React Hot Loader
- React Storybook
- Redux dev tools compatible
- Jest for tests
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@alphaThen generate your new project:
yo scalable-react-reduxgenerate a new module with in the project. This will hook up nav automatically
yo scalable-react-redux:moduleyarn start- visit app at [http://localhost:3000]
yarn storybook- visit react-storybook at [http://localhost:6001]
yarn test:watch- [ ] no tests what-so-ever
- [ ] looking into adding redux observables
- 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.
MIT © Alex Liang