README.md

Edge analytics engine is the FAR-EDGE component that enables users to perform analytics tasks "at the edge".

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/edge-analytics-engine.git

CONFIGURE

Create .env based on .env.example.

cp .env.example .env

Edit .env.

CREATE THE VIRTUAL ENVIRONMENT

cd edge-analytics-engine
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