packages/deep-microservice-analysis/README.md from ThinkDeepTech/thinkdeep

packages/deep-microservice-analysis/README.md

Summary

Maintainability

Test Coverage

Issues

# Purpose

[![Vulnerabilities](https://snyk.io/test/github/ThinkDeepTech/thinkdeep/master/badge.svg?targetFile=packages/deep-microservice-analysis/package.json)](https://snyk.io/test/github/ThinkDeepTech/thinkdeep/master?targetFile=packages/deep-microservice-analysis/package.json)

The analysis microservice is responsible for all data analysis operations. After data collection occurs, it's routed to analysis
where various algorithms will process that data and store the results to display for the user. Currently, there are no analytics
but that's soon to come.

## Developer Setup (Ubuntu)
```console
    yarn install
```
- Add the following environment variables:
    1. PREDECOS_KAFKA_HOST : Host providing access to the cluster brokers.
    1. PREDECOS_KAFKA_PORT : Port at which kafka can be accessed.
    1. PREDECOS_MONGODB_CONNECTION_STRING : Connection string for MongoDB.
    1. NODE_ENV : The node environment (i.e, development, production).