README.md

Data Service Catalogue

Tip

Read the manual: https://rodekruis.github.io/data-service-catalogue/

Development

Getting Started

With Python

• Install a Python virtual environment (On Linux/macOS):

  python3 -m venv venv
  source venv/bin/activate

• Install dependencies

  pip install -r requirements.txt

• Build the documentation

  mkdocs serve

• Preview at: http://localhost:8000

With Docker

• Install Docker: https://docs.docker.com/get-docker/

• Open a terminal at this folder to build a Docker-container:

  docker build --tag data-service-catalogue .

• Run the Docker-container:

  docker run --rm -it -p 8000:8000 -v ${PWD}:/docs data-service-catalogue

Tools in use

• Material for MkDocs: https://squidfunk.github.io/mkdocs-material/