README.md 1.81 KB
Newer Older
Konstantin Schulz's avatar
Konstantin Schulz committed
1 2
[![pipeline status](https://scm.cms.hu-berlin.de/callidus/machina-callida/badges/master/pipeline.svg)](https://scm.cms.hu-berlin.de/callidus/machina-callida/-/commits/master)
[![coverage report](https://scm.cms.hu-berlin.de/callidus/machina-callida/badges/master/coverage.svg)](https://scm.cms.hu-berlin.de/callidus/machina-callida/-/commits/master)
Konstantin Schulz's avatar
Konstantin Schulz committed
3
# Machina Callida
Konstantin Schulz's avatar
Konstantin Schulz committed
4 5 6 7 8 9 10 11 12
## Installation 
### Docker
1. Install Docker (https://docs.docker.com/v17.12/install/) and Docker-Compose (https://docs.docker.com/compose/install/).
2. Clone the repository:
    `git clone https://scm.cms.hu-berlin.de/callidus/machina-callida.git`.
3. Move to the newly created folder:
    `cd machina-callida`.
4. Run `docker-compose build`.
5. Run `docker-compose up -d`.
13

Konstantin Schulz's avatar
Konstantin Schulz committed
14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
   When using the application for the first time, it may take a few minutes until the container "mc_frontend" has finished compiling the application.
6. Visit http://localhost:8100.

### Command line 
For installation via command line, see the respective subdirectories (`mc_frontend` and `mc_backend`).

## Debugging
### Access to the Docker container
Use `docker-compose down` to stop and remove the currently running containers.

To access a running container directly, get the container ID via `docker ps` and connect via `docker exec -it CONTAINER_ID bash`. Or, for root access, use: `docker exec -u 0 -it CONTAINER_ID bash`

Alternatively, you can use `ssh root@localhost -p 8022 -o "UserKnownHostsFile /dev/null"` to connect to the container via SSH. Password is "root".

To snapshot a running container, use `docker commit CONTAINER_ID`. It returns a snapshot ID, which you can access via `docker run -it SNAPSHOT_ID`.

## Documentation
### Changelog
32
To update the changelog, use: `git log --oneline --decorate > CHANGELOG`
33 34 35 36

## Testing
### Locally
To test your code locally, run `./coverage_local.sh`