README.md

harena-logger

Harena's API for managing users and clinical cases.

Table of Contents

• herena-logger
  • Table of Contents
  • Getting Started
    • Running as Docker containers - Linux
    • Running as Docker containers - Windows
    • Running locally - Linux
    • Running locally - Windows
  • System Requirements
    • For running as Docker containers
    • For running locally
  • Configuration
    • Virtualenvs: AdonisJS
    • Virtualenvs: Database
  • Contributing
    • Project organization
    • Branch organization (future CI/CD)

Getting Started

Running as Docker containers - Linux

sudo apt-get install -y wget
wget https://github.com/datasci4health/harena-manager/blob/master/docker-compose.yml
sudo docker-compose up

Make sure you have node.js and npm already installed (see system requirements for more details).

Running as Docker containers - Windows

//to do

Running as Docker containers - Linux´

sudo docker run datasci4health/harena-logger:latest

Running locally - Linux

First, clone this repository and enter the folder:

git clone https://github.com/datasci4health/harena-logger 
cd harena-logger

cd modules/relayer                     # entering the source folder
pip3 install -r requirements.txt       # installing requirements packages for python
export FLASK_APP=server.py             # defining flask application
flask run                              # running the application

Running locally - Windows

//to do

System Requirements

For running as Docker containers

• docker
• docker-compose

For running locally

System dependencies

• flask
• flask-cors
• flask-restful
• pymongo
• kafka-python
• coloredlogs

Configuration

Virtualenvs

• HARENA_LOGGER_BROKER_HOST = mqtt host

• HARENA_LOGGER_BROKER_PORT = mqtt host port

• HARENA_LOGGER_FLASK_HOST = Flask host

• HARENA_LOGGER_FLASK_PORT = Flask port

• HARENA_LOGGER_FLASK_DEBUG = Flask debug

• HARENA_LOGGER_MONGODB_HOST = mongo host

• HARENA_LOGGER_MONGODB_PORT = mongo port

• HARENA_LOGGER_MONGODB_DB = mongo database name

• HARENA_LOGGER_MONGODB_COLLECTION = mongo current document

Contributing

Project organization

//to do

Branch organization (future CI/CD)

• feature/< label >:
  • new features.
• development:
  • Protected. Must use pull request to merge new features.
• master:
  • Version running at http://cloud.lis.ic.unicamp.br/harena/latest .
  • Protected. Must use pull request to merge evolutions of the development branch.
• tags:
  • Are used for creating Dockerhub image versions at https://cloud.docker.com/u/datasci4health/repository/docker/datasci4health/harena-logger .