README.md

Harena Manager

Harena's backend module.

Check Harena Docs Repository to get documentation

Available Services

Check https://documenter.getpostman.com/view/12184223/TzK2ZE4d to discover available endpoints provided by harena manager api.

Getting Started

We provide a docker container to locally run harena-manager code. Containers guarantee the required minimal configuration to run the code. Read docker e docker-compose documentations to install docker and learn further about containers.

In order to execute docker without sudo, read this link: https://docs.docker.com/engine/install/linux-postinstall/, which shows another optional and valuable configurations in docker environment.

Instructions (for Linux users)

Clone harena-manager repository, get into it, checkout development branch, and build the manager docker image:

git clone https://github.com/datasci4health/harena-manager.git
cd harena-manager
git checkout -b development
git pull origin development

docker build . -t manager
cd ..

Start up the docker container:

docker-compose -f docker-compose-dev.yml up

Once the start up process is done, access http://localhost:10020/ to check if the system is working.

If you want to get the command line of the container, then run the command:

docker exec -it harena-manager_harena-manager_1 bash

Contributing

Branch organization

• master:
  • The code used by our production cloud server: http://harena.ds4h.org/
  • Protected. Must use pull request to merge evolutions from development branch
• development:
  • The latest code contaning the most recent updates made by the development team
  • Changelog file show unreleased features which will be merged into master from development branch in the next release
  • Version running at http://harena.ds4h.org/development .
  • Protected. Must use pull request to merge new features.

Change log

Release updates can be found at CHANGELOG.md file.