generator-flux

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

You must have Node.js w/NPM installed. I recommend installing via homebrew, but you should be able to use the pre-built installers if you prefer.

Also, generator-flux is a Yeoman generator. If you do not have Yeoman installed, first run:

$ npm install -g yo

Installing the generator

To install generator-flux from npm, run:

$ npm install -g generator-flux

Finally, initiate the generator:

$ yo flux

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

Running the scaffolded project

Once your project is generated, you can build and open the built application by running:

$ npm start

That will launch the app and rebuild whenever you change application code. If you prefer to just build without the watch functionality, run:

$ npm run build

After First Run

The flux generator is still useful even after your app is fully generated. It comes with several subgenerators that you can invoke at any time to add new:

Components

$ yo flux:component ComponentName

Dispatchers

$ yo flux:dispatcher DispatcherName

Stores

$ yo flux:store StoreName

Actions

$ yo flux:action ActionCreatorName

License

MIT