generator-flux-react

generator-flux-react

A yeoman generator for apps, based on Flux/React architecture

generator-flux

Flux/React application generator

Getting Started

What is Flux?

It's an "Application Architecture for Building User Interfaces", built by the team at Facebook. It's a set of patterns building larger applications on top of the incredible React component library.

Prerequisites

$ npm install -g yo

Installing the generator

To install generator-flux-react from npm, run:

$ npm install -g generator-flux-react

Finally, initiate the generator:

$ yo flux-react

Configuration Options

During install-time, you will be prompted to enter some information to help create the project structure and package.json file:

• Application name (string): A human-readable name for your project, i.e. "My Flux Application"
• Machine-readable name (string): This will be used in package.json as your project identifier, and is generated automatically from the Application Name if you choose the default.
• Application Description (string): Describe your application in one sentence, to be used in package.json and the generated README.md
• css preprocessor: Choose between less and sass css preprocessors

TODO

• generators for stores and actions
• unit testing with jest
• file server gulp task
• jshint task
• e2e testing with protractor