Skip to content

harena-lab/harena-space

Repository files navigation

GitHub license Docker Automated Docker Build Docker Pulls Docker Stars JavaScript Style Guide

Harena Space

Web-based front-end module of Harena environment.

Harena is available at https://jacinto.harena.org/.

Getting Started

We provide a docker container to locally run harena-space 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 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 ..

Clone harena-space repository, get into it, checkout development branch and pull the latest code version:

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

Start up the docker container:

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

Wait for some 5 minutes, then Press Ctrl+c to stop the container. Then, re-start the container:

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

Once the start up process is done, access http://localhost:10010/ 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-space_harena-space_1 bash

Contributing

Branch organization

  • master:
    • The code used by our production cloud server: https://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.

Harena Technologies

Versum Translator

Versum Syntax and Object Representation.

Learn how the Versum translator works and its correspondent output in Versum Object Representation as well as HTML in the Translator Playground.

Digital Content Components

Digital Content Components Reference and Examples.

Learn and try to instantiate and customize Digital Content Components (DCCs) at the DCC Playground.