Krini

• TODO: Description

Getting started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

The following software is required. The used versions are indicated:

• Git, v1.8.3.1
• Docker Community Edition, v17.12.1-ce (build 7390fc6)
• Docker Compose, v1.21.2 (build a133471)

Installing

Downloading application files

Download wrapper repository including associated submodules

git clone --recurse-submodules ssh://git@git.scicore.unibas.ch:2222/krini/krini.git

Traverse to generated directory

cd krini

Switch to submodule branches configured in .gitmodules (otherwise submodules point to detached head)

git submodule foreach 'branch="$(git config -f ../.gitmodules submodule.$name.branch)"; git checkout $branch'

Updating application files

When updating the superproject including all submodules, do:

git pull origin dev
git submodule sync
git submodule foreach git pull origin dev

• Try this out instead
• git submodule sync --recursive
• git submodule update --recursive --remote

Configuring application

• TODO

Building application

docker-compose build

Deploying application

docker-compose up -d

Shutting down application

docker-compose down --volumes

Running tests

TODO: Instructions / subsections for unit, integration, e2e etc tests

Built With

• Django
• Django REST framework
• Angular
• Docker
• CWL

Authors

Main authors

• Alexander Kanitz
• Foivos Gypas

Contributors

In alphabetical order:

• Pablo Escobar

• Christina Herrmann

• Patrick Keller

• Marcel Luckeneder

• Edim Zrdalovic

• TODO: Contributors file

License

This project is licensed under the Apache 2.0 License. See the LICENSE file for details.

Acknowledgments

• TODO