Skip to content

FlowAppPlatform/flow-platform-sdk

Repository files navigation

Flow: Flow-based programming for JavaScript

Build Status codecov npm version

CloudBoost is an implementation of flow-based programming for JavaScript running on both Node.js and the browser. From WikiPedia:

In computer science, flow-based programming (FBP) is a programming paradigm that defines applications as networks of "black box" processes, which exchange data across predefined connections by message passing, where the connections are specified externally to the processes. These black box processes can be reconnected endlessly to form different applications without having to be changed internally. FBP is thus naturally component-oriented.

Developers used to the Unix philosophy should be immediately familiar with FBP:

This is the Unix philosophy: Write programs that do one thing and do it well. Write programs to work together. Write programs to handle text streams, because that is a universal interface.

It also fits well in Alan Kay's original idea of object-oriented programming:

I thought of objects being like biological cells and/or individual computers on a network, only able to communicate with messages (so messaging came at the very beginning -- it took a while to see how to do messaging in a programming language efficiently enough to be useful).

CloudBoost components can be written in JavaScript. The system is heavily inspired by J. Paul Morrison's book Flow-Based Programming.

Suitability

CloudBoost Flow is not a web framework or a UI toolkit. It is a way to coordinate and reorganize data flow in any JavaScript application. As such, it can be used for whatever purpose JavaScript can be used for.

Requirements and installing

CloudBoost Flow is available for Node.js via NPM, so you can install it with:

$ npm install flow-platform-sdk --save

Installing from Git

CloudBoost Flow requires a reasonably recent version of Node.js, and some npm packages. Ensure that you have CloudBoost Flow checked out from Git, and all NPM dependencies installed. Build and test CloudBoost Flow with:

$ npm run-script test

CloudBoost Flow is available from GitHub under the MIT license.

Development

CloudBoost Flow development happens on GitHub. Just fork the main repository, make modifications and send a pull request.

We have an extensive suite of tests available for CloudBoost Flow. Run them with:

$ npm run-script test

Docs

If you want to build new components using Flow SDK. Please read out the documentation for the SDK here.

Contributing

If you're contributing to the Flow SDK. Please read the docs here.