From e1f37a8dbb8be1e8646e2cc492d35f17bceb095c Mon Sep 17 00:00:00 2001 From: "IETM_FIXE\\ietm6" Date: Sun, 19 Apr 2026 12:18:40 +0200 Subject: [PATCH] Ajout du Readme --- README.md | 68 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 68 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..49349d2 --- /dev/null +++ b/README.md @@ -0,0 +1,68 @@ +# LoreMind đŸŽČ + +Application web d'aide aux MaĂźtres de Jeu (JDR) pour centraliser la gestion de l'univers (Lore) et le suivi des campagnes, avec un moteur IA intĂ©grĂ© pour gĂ©nĂ©rer du contenu structurĂ©. + +## 🌟 FonctionnalitĂ©s + +- **Gestion centralisĂ©e du Lore** : Lieux, Factions, PNJ, et tous les Ă©lĂ©ments de votre univers +- **Suivi de campagnes** : Sessions, actions des joueurs, chronologie +- **Moteur IA intĂ©grĂ©** : GĂ©nĂ©ration automatique de contenu (PNJ, Villes, QuĂȘtes) Ă  partir de templates +- **Export vers FoundryVTT** : Transfert structurĂ© des donnĂ©es vers votre VTT prĂ©fĂ©rĂ© (en dĂ©veloppement) + +## 🛠 Stack Technologique + +LoreMind utilise une architecture distribuĂ©e pour sĂ©parer les responsabilitĂ©s : + +- **Frontend** : Angular (Interface utilisateur, affichage du lore, formulaires de templates) +- **Backend Core** : Java (Spring Boot) - Orchestration, persistance, export VTT +- **Backend IA** : Python - Traitement des LLM et gĂ©nĂ©ration de contenu +- **Base de donnĂ©es** : PostgreSQL avec JSONB pour les templates flexibles + +## 🏗 Architecture + +### Backend Java (Domain-Driven Design & Hexagonal) + +Le Backend Core respecte strictement : +- **Domain-Driven Design (DDD)** : SĂ©paration en Bounded Contexts autonomes +- **Architecture Hexagonale (Ports et Adaptateurs)** : Domaine pur sans dĂ©pendances techniques + +#### Bounded Contexts +- **LoreContext** : Gestion de l'encyclopĂ©die de l'univers +- **CampaignContext** : Suivi des sessions et chronologie +- **GenerationContext** : Gestion des requĂȘtes IA et templates + +#### Couches +- **Domaine (Core)** : EntitĂ©s mĂ©tier pures et interfaces (Ports) +- **Application** : Orchestration des flux (Use Cases) +- **Infrastructure** : ImplĂ©mentation technique (Adapters) + +## 🚀 Installation rapide avec Docker + +### PrĂ©requis +- Docker et Docker Compose installĂ©s + +### DĂ©marrage + +```bash +# Clone du repository +git clone https://ton-gitea.com/ton-user/LoreMind.git +cd LoreMind + +# Lancement de tous les services +docker-compose up -d + +# L'application est accessible sur : +# - Frontend : http://localhost:4200 +# - Backend Core : http://localhost:8080 +# - Backend IA : http://localhost:8000 +``` + +### ArrĂȘt + +```bash +docker-compose down +``` + +## License + +[À dĂ©finir]