Files
pepperplus-cb/README.md
Kasper Marinus 826907643c docs: update README
Add an instruction for running the development server.
2025-10-08 15:05:39 +02:00

24 lines
650 B
Markdown

## Development environment
We begin by installing UV (very nice utility for managing packages and Python version):
```bash
# On macOS and Linux.
curl -LsSf https://astral.sh/uv/install.sh | sh
```
```bash
# On Windows.
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
```
Using UV, installing the packages and virtual environment is as simple as typing the following (inside the root directory of this repository):
```bash
uv sync
```
## Running
To run the project (development server), execute the following command (while inside the root repository):
```bash
uv run fastapi dev src/control_backend/main.py
```