TESTING.md

How to Test

• A. Via Python
• B. Via Docker

A. Via Python

0. Have Python installed.
   ^{Known supported versions are from 3.10 to 3.12.}
1. Install Poetry to manage dependencies.
   ^{You should only need to do this once.}
2. Navigate into your clone of this repo.
3. Install/Update project dependencies:
   ^{You should only need to do this after new releases.}

   poetry install --sync

4. Activate project dependencies:\

   poetry shell

   ^{After the poetry shell command, you should be in a Poetry-managed environment. Your prompt might be prefixed with the name of the environment.}
5. Serve the docs:\

   mkdocs serve

6. Open the website at the URL echoed by the program e.g. http://127.0.0.1:8000/.

B. Via Docker

0. Have Docker installed.
   ^{We recommend doing so via Docker-Desktop.}

1. Navigate into your clone of this repository.

2. Start the Docker container to serve the docs.

   Using Make:

    make build
    make start

   Or:

    docker compose build
    docker compose up

3. Open the website at the URL provided e.g. http://localhost:8000/.