dooris/README.md
lilly d3814a359d
recommend watchexec for development instead of calling uvicorn
This lets us setup initialization logic much more uniformly
(e.g. configuring loggers)
2026-05-04 11:01:09 +02:00

21 lines
711 B
Markdown

# Dooris
Dooris setup using HomeMatic with Web UI, API and OIDC integration.
Based on prior work of [hmdooris](https://git.hamburg.ccc.de/CCCHH/hmdooris).
Project structure:
```
├── api # Python application interacting with HomeMatic and providing the API.
└── app # Web UI
```
## API Development
Most things should automatically be set up with the included [direnv script](./.envrc.dist) but if you don't use that, take the following steps:
1. Go to the api/ directory
2. Run `uv venv` to create a python virtual environment
3. Install all dependencies of the dooris project into that virtual environment with `uv sync`
4. Run a development server `watchexec -r -w src/ uv run dooris-api`