Installation

You have a few options when it comes to installing Fluxxor. Keep in mind that, while Fluxxor works great with React, React is not required for Fluxxor.

CommonJS Module Bundlers

Fluxxor is distributed on npm. You can install it with

npm install [--save] fluxxor

If you're using a client-side module bundler like Browserify or Webpack, you're done! Simply require("fluxxor") to get a reference to the library.

Browser Builds

Browser builds and corresponding source map files can be downloaded from the Fluxxor releases page or installed via Bower via bower install fluxxor. Browser builds use a universal module definition, and should work in the following environments:

CommonJS

var Fluxxor = require("path/to/fluxxor");

AMD

define("someModule", ["Fluxxor"], function(Fluxxor) {
  // ...
});

Standalone

<script src="path/to/fluxxor.js"></script>

window.Fluxxor.createStore({ ... });

Third-Party Releases

The following releases are maintained by third parties, and support inquiries should be directed to their maintainers.

WebJar

For JVM languages, there are WebJar packages available on Maven Central and jsDelivr as the following:

SBT/Play Framework 2:

"org.webjars" % "fluxxor" % fluxxorVersion

Maven:

<dependency>
    <groupId>org.webjars</groupId>
    <artifactId>fluxxor</artifactId>
    <version>${fluxxor.version}</version>
</dependency>

For detailed instructions, refer to the WebJars documentation. For update requests, open a pull request on the Fluxxor WebJar repository on Github.

Browser Compatibility

Fluxxor is compatible with any ES5-compliant browser (IE 9+, FF 4+, Safari 5.1.4+, Chrome 19+, Opera 12.10+). You can use es5-shim for other browsers.

Getting Started

Check out the quick-start guide to get up-to-speed building apps with Fluxxor in no time.