docs: add project README with setup and usage instructions

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
2026-02-13 05:34:01 +01:00
parent d271697d43
commit ae1978b17c

42
README.md Normal file
View File

@@ -0,0 +1,42 @@
# Plesna Gerance
Extracteur de comptes rendus de gerance Oralia/ICS.
## Prerequis
- Python >= 3.10
- [uv](https://docs.astral.sh/uv/)
- Node.js >= 22
- poppler-utils (`apt install poppler-utils` ou `pacman -S poppler`)
## Installation
```bash
uv sync
cd frontend && npm install
```
## Developpement
Lancer backend et frontend dans deux terminaux separés :
```bash
make dev_back # Backend sur http://localhost:8000 (auto-reload)
make dev_front # Frontend sur http://localhost:5173 (hot-reload)
```
Ou les deux en parallele :
```bash
make dev
```
Ouvrir **http://localhost:5173** — le proxy Vite redirige `/api` vers le backend.
## Production (Docker)
```bash
make docker
```
Accessible sur **http://localhost:8080**.