Newer
Older
[](https://scm.cms.hu-berlin.de/callidus/machina-callida/-/commits/master)
[](https://scm.cms.hu-berlin.de/callidus/machina-callida/-/commits/master)
## 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 `./deploy.sh`.
When using the application for the first time, it may take a few minutes until the container "mc_frontend" has finished compiling the application.
5. 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`.
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`.
Konstantin Schulz
committed
## Models
To generate class structures for this project automatically:
1. Install OpenAPI Generator (using, e.g., `brew install openapi-generator`).
2. Run: `openapi-generator generate -i mc_backend/mcserver/mcserver_api.yaml -g typescript-angular -o mc_frontend/openapi/ && openapi-generator generate -i mc_backend/mcserver/mcserver_api.yaml -g python-flask -o mc_backend/openapi/ && python mc_backend/openapi_generator.py`.
Konstantin Schulz
committed
Note: If an **unused Enum** is specified in the API documentation, it will not be generated. To force-generate its model, provide a second, derived schema that relies on the Enum using allOf-inheritance.
Konstantin Schulz
committed
### API
Konstantin Schulz
committed
To view the official API documentation, visit https://korpling.org/mc-service/mc/api/v1.0/ui/ .
If you make local changes to the source code, your own API documentation will be published at http://localhost:5000/mc/api/v1.0/ui/ .
The port (5000) and API path (/mc/api/v1.0/) may change depending on your configuration.
To update the changelog, use: `git log --oneline --decorate > CHANGELOG`
## Testing
### Locally
To test your code locally, run `./coverage_local.sh`