Skip to content

Commit d464cda

Browse files
authored
Update README.md
1 parent c611ff7 commit d464cda

File tree

1 file changed

+44
-2
lines changed

1 file changed

+44
-2
lines changed

README.md

Lines changed: 44 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,14 @@
44
>
55
> Un consortium composé de quatre entreprises leaders s’est formé pour mutualiser leurs efforts, données, applications et feuilles de route, afin de développer une plateforme de nouvelle génération, centrée sur le patient. Celle-ci vise à améliorer les soins de base tout en étant réactive, opérationnelle en temps réel et capable de prendre des décisions critiques en situation d’urgence, en tenant compte de toutes les données disponibles.
66
7+
## Diagramme d'architecture
8+
9+
10+
11+
> Note : Dans le cadre des développements, une seule base de données est démarrée, avec des schémas différents initalisé par chaque microservice.
12+
713
## 📁 Structure du projet
14+
815
Le dépôt est organisé de la manière suivante :
916

1017
```bash
@@ -21,7 +28,19 @@ Le dépôt est organisé de la manière suivante :
2128

2229
## ⚙️ Configuration de votre environnement local
2330

24-
Avant toute chose, clonez ce projet sur votre machine.
31+
### Prérequis
32+
33+
Afin de démarrer vos développements, vous devez avoir :
34+
- **Java 21**
35+
- **Maven**
36+
- **Node 20** et **Angular CLI**
37+
- **Docker Desktop** et **Docker compose** d'intallé
38+
- Un **IDE** (Intellij, VsCode) : nous recommandons IntelliJ.
39+
- Optionnel :
40+
- Apache JMeter. Reportez vous à [la documentation en lien](./jmeter/README.md).
41+
- Un client d'API ([Bruno](https://www.usebruno.com/), [Postman](https://www.postman.com/), [Insomnia](https://insomnia.rest/download)). Les collections Bruno et Postman sont disponibles [ici](./docs).
42+
43+
Clonez ce projet sur votre machine.
2544

2645
### 📦 Démarrer les composants liés aux microservices
2746

@@ -36,8 +55,31 @@ Pour stocker les données de manière persistante et permettre à l’applicatio
3655
- `rm -rf kafka_data:/var/lib/kafka/data` pour les données d'évènements.
3756
4. Exécutez la commande `docker compose up` depuis la racine du projet pour démarrer les composants :
3857

58+
> 💡 Les microservices ayant besoin d'une base de données relationelle ne démarreront pas si la base de bonnée n'est pas préalablement démarrée.
59+
60+
### Démarrer les microservices
61+
62+
Pour démarrer les microservices de manière pratique :
63+
1. Ouvrez le dossier `backend` dans votre IDE IntelliJ
64+
2. Depuis la fenêtre **Services**, lancez 1 à 1 vos microservices en respectant l'odre de démarrage :
65+
1. Discovery Service
66+
2. Hospital & Emergency Service (peu importe le sens)
67+
3. Gateway Service
68+
69+
> Note : De cette manière, les services vont s'enregistrer aurpès du Discovery Server et l'API Gateway saura router correctement les requêtes entrantes
70+
71+
### Démarrer l'application frontend Anuglar
72+
73+
Pour démarrer l'application Angular, placez vous dans le dossier d'application, installez les packages et lancez l'application :
74+
75+
```bash
76+
cd ./frontend/realtime-emergency-app/
77+
npm i
78+
ng serve
79+
```
80+
3981
## 🧱 Gestion des migrations de données avec Liquibase
40-
Nous utilisons Liquibase pour versionner les changements de structure, gérer les migrations de données, et peupler la base avec des données de test.
82+
Nous utilisons [**Liquibase**](https://www.liquibase.com/) pour versionner les changements de structure, gérer les migrations de données, et peupler la base avec des données de test.
4183

4284
> 💡 Nous utilisons le plugin [IntelliJ JPA Buddy](https://plugins.jetbrains.com/plugin/15075-jpa-buddy) pour générer les changelogs à partir des entités JPA, évitant ainsi les scripts SQL manuels.
4385
> Toutes les modifications proviennent directement des entités de chaque domaine.

0 commit comments

Comments
 (0)