Ajout du Readme

This commit is contained in:
2026-04-19 12:18:40 +02:00
parent b3e0e0883b
commit cbb2abc861

68
README.md Normal file
View File

@@ -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]