Skip to content

Commit

Permalink
docs: update documentation to use uv
Browse files Browse the repository at this point in the history
  • Loading branch information
jorgenengelsen committed Aug 23, 2024
1 parent 14f0c1d commit 825f615
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 3 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
22 changes: 20 additions & 2 deletions documentation/docs/about/running/01-prerequisites.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.




0 comments on commit 825f615

Please sign in to comment.