diff --git a/README.md b/README.md index b12e7faa..3847b079 100644 --- a/README.md +++ b/README.md @@ -63,7 +63,7 @@ Create a copy of `.env-template` called `.env` and populate it with values. Once you have done the configuration, you can start running: ```sh -docker-compose up +docker compose up ``` The application will be served at http://localhost diff --git a/documentation/docs/about/running/01-prerequisites.md b/documentation/docs/about/running/01-prerequisites.md index 9564ae5d..c7781ef0 100644 --- a/documentation/docs/about/running/01-prerequisites.md +++ b/documentation/docs/about/running/01-prerequisites.md @@ -3,6 +3,24 @@ In order to run you need to have installed: - [Docker](https://www.docker.com/) -- [Docker Compose](https://docs.docker.com/compose/) - Git -- [Python](https://www.python.org/) (3.10 or newer) + +## Local setup for backend development + +This template uses [uv](https://docs.astral.sh/uv/) as package and project manager. + +Follow the installation instructions for your OS, then verify your uv installation by running: +```zsh +uv --version +``` + +To set up your python environment, go to the `/api` foler, from here you can either do it explicitly with `uv sync --dev` or simply run: +```zsh +uv run pre-commit +``` + +This will automagically install the required python version (if needed), create a venv for the project and install the required dependencies defined in the pyproject.toml file. + + + +