Open API for Analytics defines a set of public endpoints that enable external systems to interact with the Distributed Data Analytics component both at the edge and at the ledger tier, and deploy their own custom data analytics logic.

REQUIREMENTS

• Confluent Platform >= 4.1.1
• MongoDB >= 3.6.4
• Node.js >= 10.1.0
• npm >= 5.6.0

CLONE

git clone git@github.com:far-edge/open-api-for-analytics.git

CONFIGURE

Create .env based on .env.example.

cp .env.example .env

Edit .env.

CREATE THE VIRTUAL ENVIRONMENT

cd open-api-for-analytics
nodeenv -n 10.1.0 --prebuilt env

ACTIVATE THE VIRTUAL ENVIRONMENT

. env/bin/activate

INSTALL THE DEPENDENCIES

npm install

RUN

npm start

DEACTIVATE THE VIRTUAL ENVIRONMENT

deactivate_node

LINT

npm run lint

TEST

npm test

GENERATE THE DOCUMENTATION

npm run doc