From c0c287ea33c84f4194e7fab2962a0303bbe7b084 Mon Sep 17 00:00:00 2001 From: Yoann Talon <84589845+swyth-dev@users.noreply.github.com> Date: Tue, 8 Apr 2025 09:21:13 +0200 Subject: [PATCH] Update README.md --- README.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index b16369b..9089a23 100644 --- a/README.md +++ b/README.md @@ -26,16 +26,18 @@ Avant toute chose, clonez ce projet sur votre machine. ### 📦 Démarrer les composants liés aux microservices Pour stocker les données de manière persistante et permettre à l’application de démarrer correctement, ainsi qu'assurer la communication des évènements, vous devez démarrer certains composants : -- PostgreSQl : Système de gestion de base de donnée relationelle. Pour cette PoC, une seule DB est démarrée, et chaque microservice utilise son propre schéma. En production, chaque micro service utilise sa propre instance de DB -- Kafka : Plateforme de messagerie distribuée qui permet aux services de communiquer en temps réel via des événements. -- Kafka UI : Interface web pour superviser les brokers Kafka, et notamment les événements liés à la réservation de lit. +- **PostgreSQL** : Système de gestion de base de donnée relationelle. Pour cette PoC, une seule DB est démarrée, et chaque microservice utilise son propre schéma. En production, chaque micro service utilise sa propre instance de DB +- **Kafka** : Plateforme de messagerie distribuée qui permet aux services de communiquer en temps réel via des événements. +- **Kafka UI** : Interface web pour superviser les brokers Kafka, et notamment les événements liés à la réservation de lit. 1. [**Installez Docker Desktop**](https://docs.docker.com/desktop/) sur votre machine. - -2. Exécutez la commande `docker compose up` depuis la racine du projet pour démarrer les composants : +2. (**Optionnel**) Effacez les volumes locaux de persistance : + - `rm -rf db_data:/var/lib/postgresql/data` pour les données relationelles. + - `rm -rf kafka_data:/var/lib/kafka/data` pour les données d'évènements. +4. Exécutez la commande `docker compose up` depuis la racine du projet pour démarrer les composants : ## 🧱 Gestion des migrations de données avec Liquibase 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. > 💡 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. -> Toutes les modifications proviennent directement du modèle de domaine. +> Toutes les modifications proviennent directement des entités de chaque domaine.