Prerequisites¶

This project uses Devbox to manage the development environment. Devbox provides a consistent, isolated environment with all the necessary CLI tools pre-installed.

Docker¶

• Follow the installation instructions for your operating system.

The rest of the tools are already installed in the devbox environment

Devbox¶

• Follow the installation instructions for your operating system.

Clone the Repository¶

git clone https://github.com/your-username/your-repo.git
cd your-repo

Start the Devbox Environment and poetry environment¶

devbox shell # Start the devbox environment (this will also start the poetry environment)
poetry install # Install dependencies
poetry env activate # use the output to activate the poetry environment ( ONLY IF DEVBOX DOES NOT ACTIVATE THE ENVIRONMENT)
mkdocs serve # Start the mkdocs server http://127.0.0.1:8000/your-repo/