riv

Riv is a framework which implements the Flux-Architecture designed by Facebook. It is implement in ES6 to guarantee you a 100% integration into newer version of node. It is compatible with Node.js (ES5, ES6) but also with the Browser. It helps you writing asynchron applications without breaking your head and giving you a clean strucutre with Dispatchers.

Installation

You can install riv via NPM (Node Package Manager) via your systems command line interface if you'd like to use it as a Node.js dependency. Additionaly riv is avaible on bower since 2016 to enable you a stress-free install as a frontend dependency. The installations is pretty easy, just take a look below!

npm install riv --save
bower install riv --save

Platforms

If you decide to use Riv within the browser, it is recommended to install it via bower and include the minified export under /dist. If you're planning to use riv with node and you're using a node environement which fully supports ES6, you can install the package via NPM and use the file /platforms/es6. If you want to use the ES5 version, just simply require('riv').

Custom Build

# Download the latest code from GitHub 
git clone https://github.com/janbiasi/riv.git
cd riv
 
# Install Node.js dependencies 
npm install
 
# Using Gulp to build 
gulp

Supported Node.js Versions

• 4.2
• 4.1
• 4.0
• 0.12
• 0.11
• 0.10
• iojs

Adjusting Build Process

If you want to adjust the whole building process - you can. Please visit the NPM or the GitHub repository of the few tasks in the gulpfile to get more information about them and their usage as well as configuration - thanks!

Usage

Node.js

If you're using Node.js to work with riv, you can use the default required keyword to render the riv module.

var Riv = require('riv');
var Store = new Riv.Store();
var Dispatcher = new Riv.Dispatcher();

Browser

Using riv in the browser is pretty easy, it's global accessible via the window in your webapplication.

var Dispatcher = new Riv.Dispatcher();
var Store = new Riv.Store();

View full and complex examples