aswi2021jmsd-gitlab4/README.md @ d1c800c1

# Application for X.509 certificate management 

[![pipeline status](https://gitlab.kiv.zcu.cz/aswi/aswi-2021/aswi2021jmsd/badges/master/pipeline.svg)](https://gitlab.kiv.zcu.cz/aswi/aswi-2021/aswi2021jmsd/-/commits/master)
[![coverage](https://gitlab.kiv.zcu.cz/aswi/aswi-2021/aswi2021jmsd/badges/master/coverage.svg)](https://gitlab.kiv.zcu.cz/aswi/aswi-2021/aswi2021jmsd/-/commits/master)

**API definition:** ![swagger.yaml](https://gitlab.kiv.zcu.cz/aswi/aswi-2021/aswi2021jmsd/-/blob/master/src/swagger.yaml)

- **Python 3.8** was used during the development of this application - it is the recommended interpreter to be used to run this application


## Testing
- `pytest` framework is used for testing
- tests are stored in the `tests` folder
- can be run in PyCharm IDE (see [tutorial](https://www.jetbrains.com/help/pycharm/pytest.html)) or by calling `pytest` in the project's root directory
- Robot Framework tests are located in the `robot_tests` directory

## Deployment via Docker
- run `docker-compose up` in the project's root directory
    - consists of gunicorn WSGI and nginx containers
    - app is then available at [localhost](http://localhost)