generator-atomic-react

Generator-React-Webpack - with Flux Support (using Redux)

What is it for?

This generator can be used to create and manage projects that use React, Webpack and Flux (using Redux as implementation) using Atomic Design. It depends on generator-react-webpack as a base and extends it to create new reducers and actions.

What is included?

generator-atomic-react includes support for creating new reducers (and tests), as well as the creation of actions, atoms, molecules, organisms and ecosystems.

It also has support for the the features that are available in its parent project, generator-react-webpack. This includes the run-configuration, webpack, esLint and test-environment.

Planned Features and updates

There are currently some features missing from the generator. These will be available in a later version:

• Add optional routing via react-router-redux

Installation

npm install -g yo
npm install -g generator-atomic-react

Setting up projects

# Create a new directory, and `cd` into it:
mkdir my-new-project && cd my-new-project

# Run the generator
yo atomic-react

Generating new reducers

yo atomic-react:reducer my/namespaced/reducers/name
yo atomic-react:reducer items

Generating new actions

yo atomic-react:action my/namespaced/actions/name
yo atomic-react:action items/addItem

Generating new atoms

yo atomic-react:atom my/namespaced/components/name

Generating new molecules

yo atomic-react:molecule my/namespaced/components/name

Generating new organisms

yo atomic-react:organism my/namespaced/components/name

Generating new ecosystems

yo atomic-react:ecosystem my/namespaced/container/Name

Usage

Please take a look at react-webpack-template for an in depth explanation or use npm run to get a list of all commands available for building and running your application.

Basics are:

• npm start: Will start up the dev webserver
• npm test: Run unit tests
• npm run dist: Create the packed version

Contribute

Contributions are welcome. If you find something is missing or there are errors hidden somewhere, feel free to add a new issue.

If you want to submit a pull request please to so from and against the develop branch.

Running Tests

npm test or node node_modules/.bin/mocha

License

MIT license