feat: improve README

This commit is contained in:
Florian Briand 2024-09-23 18:43:44 +02:00
parent 54870b0d0f
commit 43bb2c40de
Signed by: florian_briand
GPG Key ID: CC981B9E6B98E70B

View File

@ -5,6 +5,7 @@ Logiciel de Pharmacie libre et open-source.
## Modules applicatifs
- `crates`: Dossier racine des modules Rust
- `crates/backend`: Serveur backend propulsé par Axum, exposant une API REST
- `crates/desktop`: Client desktop propulsé par Tauri, exposant le `frontend`
- `crates/sesam-vitale`: Bibliothèque de gestion des services SESAM-Vitale (Lecture des cartes CPS et Vitale, téléservices ...)
- `crates/utils`: Bibliothèque de fonctions utilitaires
@ -52,17 +53,20 @@ Voir le [README](crates/backend/README.md) de la crate `backend` pour les prére
### Lancement
Le logiciel dans sa globalité peut être lancé via la commande suivante :
Pour lancer l'application en mode développement, il est nécessaire d'exécuter plusieurs composants simultanément :
```bash
cargo tauri dev
# Lancement du serveur backend
systemfd --no-pid -s http::3030 -- cargo watch -x 'run --bin backend'
```
Si vous souhaitez lancer les composants séparément, les indications de lancement sont disponibles dans les README des différents crates.
- [backend](crates/backend/README.md)
- [frontend](frontend/README.md)
- [sesam-vitale](crates/sesam-vitale/README.md)
```bash
# Lancement de l'interface utilisateur (frontend ou desktop)
# - frontend (serveur web, accessible via navigateur)
bun run --cwd frontend/ dev
# - desktop (client desktop, basé sur Tauri)
cargo tauri dev
```
## Build