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. Clone the repo. If using GitHub CLI, run:

    gh repo clone pyladies/pyladiescon-portal

  2. Start the local environment:

    make serve

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

  4. 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

  2. Install docs requirements:

    pip install -r requirements-docs.txt

  3. Run the docs server:

    mkdocs serve -a localhost:8888

  4. 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, follow the instructions on how to resolve it.