exynize-rest's Introduction

Exynize REST server for Exynize platform

Exynize REST server that provides a way to run user-created components and pipelines in node. Part of Exynize platform.

About Exynize platform

Exynize platform aims to simplifying the workflow and allow rapid creation of data processing pipelines and visualisations. Current version of the platform allows:

constructing pipelines right in your browsers with very little effort,
writing processing component as if you was dealing with a single data item,
re-using existing processing modules in new pipelines,
creating real-time processing and visualisation without thinking about doing real-time at all,
spending time on doing actual work, not fiddling with scaffolding.

More info on the platform as well as some demoes of its capabilities can be found in the following article on Medium

Building data processing and visualisation pipelines in the browser with Exynize

Getting started

Requirements

For Exynize REST to function properly, you'll need to have following things installed:

node.js v4.x or later
npm v3.x or later
docker (used to start RethinkDB) or RethinkDB

Alternatively you can use docker environment provided with a supplied Dockerfile.

Installation

Clone the repository and cd into new folder: git clone [email protected]:Exynize/exynize-rest.git && cd exynize-rest
Execute npm install
Execute npm start (this will also start a docker container with RethinkDB)
Exynize REST will start working on http://localhost:8080

If you have local RethinkDB instance, you can just use npm run server in step 3.

Alternatively, you can use Dockerfile to assemble docker container and then start it with a link to your RethinkDB instance.