Skip to content

Local Dev setup

Requirements: Have these installed first before continuing further.

  • Docker
  • Docker compose
  • GNU Make
  • GitHub CLI (optional, but recommended) https://cli.github.com/

Starting the local env

  1. Fork the repo. See the GitHub docs for instructions on how to Fork a repo.

  2. Clone your fork. If using GitHub CLI, run:

gh repo clone <personal-account>/pyladiescon-portal
  1. Start the local environment:
make serve

  1. Open the browser and go to http://localhost:8000/ to see the app running.

  2. Run the tests:

make test

Documentation Setup

The documentation is built using MKDocs and markdown.

Local docs setup

  1. Create and activate a virtual environment:
python3 -m venv venv
source venv/bin/activate
  1. Install docs requirements:
pip install -r requirements-docs.txt
  1. Run the docs server:
mkdocs serve -a localhost:8888
  1. Open the browser and go to http://localhost:8888/ to see the docs running.

Docs Troubleshooting

Cairo library was not found

If you see the error Cairo library was not found, try the following instructions:

  1. MKDocs material image processing Docs.

  2. Check if the Cairo libraries are listed in /opt/homebrew/lib folder. If not, follow the instructions on this page.