added docs

Author: intel1337

Documents/LadderThroughProject.md

@@ -0,0 +1,34 @@
+## Difficultés rencontrées et solutions apportées
+
+### .NET & C#
+
+**Difficultés :**
+- Le langage C# m’était totalement inconnu, ce qui a entraîné des difficultés avec la syntaxe et les conventions.
+- La documentation officielle de .NET s’est révélée souvent peu claire, en particulier sur certains aspects du framework.
+
+**Solutions :**
+- Étude de code existant pour assimiler les bases du langage.
+- Entraînement progressif à travers des exemples simples.
+- Approfondissement de l’architecture MVC avec .NET pour mieux structurer l’application.
+
+### Svelte
+
+**Difficultés :**
+- Manque de familiarité avec la couche service dans Svelte.
+- Confusion entre les variables et fonctions accessibles côté client et celles réservées au serveur.
+
+**Solutions :**
+- Lecture approfondie de la documentation officielle.
+- Tests pratiques pour bien comprendre la séparation client/serveur dans SvelteKit.
+
+### Docker & PostgreSQL
+
+**Difficultés :**
+- Déploiement de la base de données PostgreSQL via Docker particulièrement complexe.
+- Entity Framework Core posait des problèmes de connexion à PostgreSQL sur macOS.
+- L’erreur était liée à au conteneur officiel lui même
+
+**Solutions :**
+- Analyse des logs et troubleshooting approfondi des conteneurs.
+- Résolution manuelle du problème en identifiant et corrigeant la dépendance responsable.
+

Documents/MCD.png

@@ -1,76 +1,123 @@
-# LibreScript – Projet ASP.NET Core & Svelte
-
-## Présentation
-LibreScript est une application web composée d’un backend ASP.NET Core (C#) et d’un frontend Svelte. Elle permet la gestion d’utilisateurs, de posts, de catégories et de commentaires, dans un style blog/forum moderne.
-
-## Architecture & Design Pattern
-- **Backend** : ASP.NET Core (C#), architecture RESTful, pattern MVC (Model-View-Controller)
-- **Frontend** : Svelte (Vite)
-- **Base de données** : PostgreSQL (via Entity Framework Core)
-- **Séparation des responsabilités** :
-  - **Controllers** : gèrent les routes HTTP, la logique métier et la validation des requêtes
-  - **Models/Entities** : représentent les tables de la base de données
-  - **DbContext** : centralise l’accès à la base de données
-
-
-## Fonctionnalités principales
-- **Gestion des utilisateurs** :
-  - Inscription, connexion (routes prêtes à être implémentées)
-  - Recherche par ID ou username
-- **Gestion des posts** :
-  - CRUD complet (création, lecture, modification, suppression)
-  - Association à un utilisateur
-- **Gestion des catégories** :
-  - CRUD complet
-  - Association de posts à des catégories
-- **Gestion des commentaires** :
-  - CRUD complet
-  - Réponses imbriquées (replies)
-  - Association à un post et à un utilisateur
-- **CORS configuré** pour permettre l’accès au backend depuis le frontend local
-- **Configuration flexible** de la base de données via `appsettings.json`
-
-## Design technique
-- **Pattern MVC** :
-  - Les contrôleurs exposent des routes REST (ex : `/api/post`, `/api/category`...)
-  - Les entités (models) sont mappées sur les tables PostgreSQL
-  - Le DbContext gère les transactions et le suivi des entités
-- **Asynchrone** : la plupart des opérations sont asynchrones pour de meilleures performances
-- **Sécurité** : endpoints prêts pour l’ajout d’authentification/autorisation
-
-## Lancement du projet
-1. **Backend**
-   - Configurer la base de données dans `appsettings.json` si besoin
-   - Lancer le backend :
-     ```bash
-     cd dotnetBackend
-     dotnet run
-     ```
-2. **Frontend**
-   - Installer les dépendances et lancer le serveur Svelte :
-     ```bash
-     cd svelteFrontEnd
-     npm install
-     npm run dev
-     ```
-
-## Exemples de routes API
-- `GET /api/user/get-user/id/{id}` : récupérer un utilisateur par ID
-- `POST /api/post` : créer un post
-- `PUT /api/category/{id}` : modifier une catégorie
-- `DELETE /api/comment/{id}` : supprimer un commentaire
-
-## Pour aller plus loin
-- Ajouter l’authentification JWT
-- Ajouter la pagination, la recherche, le tri
-- Améliorer la gestion des erreurs et la validation
-- Ajouter des tests unitaires et d’intégration
-- **Déployer le projet avec Docker et Kubernetes** :
-  - Créer des fichiers Dockerfile pour le backend et le frontend
-  - Écrire des manifests Kubernetes (Deployment, Service, Ingress)
-  - Utiliser un cluster local (ex : minikube) ou cloud (AKS, GKE, EKS)
-  - Gérer la persistance de la base PostgreSQL avec un PersistentVolume
-  - Ajouter un fichier README/k8s.md pour la documentation du déploiement
-
----
-Projet réalisé dans le cadre d’un projet de fin d’année.
+# LibreScript
+
+LibreScript est une application web / de bureau moderne développée avec une architecture full-stack, combinant un backend .NET et un frontend Svelte.
+
+## Architecture du Projet
+
+### Backend (.NET)
+Le backend est développé en C# avec .NET et comprend :
+- Une API RESTful
+- Une base de données avec Entity Framework Core
+- Des migrations pour la gestion du schéma de base de données
+- Une configuration Docker pour le déploiement
+- Une configuration Kubernetes pour l'orchestration
+
+### Frontend (Svelte)
+Le frontend est développé avec Svelte et comprend :
+- Une interface utilisateur moderne et réactive
+- Une intégration Electron pour le déploiement en tant qu'application de bureau
+- Une Intégration Web / Web Mobile
+- Une configuration de build optimisée
+- Des outils de développement modernes (ESLint, Vite, prettier)
+
+## Prérequis
+
+- .NET SDK 8.0 ou supérieur
+- Node.js 18 ou supérieur
+- Docker (optionnel, pour le déploiement)
+- Kubernetes (optionnel, pour l'orchestration)
+
+## Installation
+
+### Backend
+```bash
+cd dotnetBackend
+# Mac, Linux, BSD : ./setup.sh
+# Windows :  start setup.bat
+dotnet restore
+# Optional : dotnet build 
+# Ne Pas oublier de setup une db Postgres et l'url dans appsettings.json (Si docker utiliser une image postgres Docker)
+```
+
+### Frontend
+```bash
+cd svelteFrontEnd
+npm install
+```
+
+## Démarrage
+
+### Backend
+```bash
+cd dotnetBackend
+dotnet run
+```
+
+### Frontend
+```bash
+cd svelteFrontEnd
+npm run dev
+
+```
+
+## Déploiement
+
+### Docker
+Le projet inclut des configurations Docker pour le déploiement :
+- `Dockerfile` pour le backend
+- Configuration Kubernetes dans le dossier `k8s`
+
+### CI/CD
+Le projet inclut des configurations GitHub Actions pour l'intégration et le déploiement continus.
+
+## Structure des Dossiers
+
+```
+LibreScript/
+├── dotnetBackend/          # Backend .NET
+│   ├── Controllers/       # Contrôleurs API
+│   ├── Models/           # Modèles de données
+│   ├── Data/             # Contexte de base de données
+│   ├── Migrations/       # Migrations EF Core
+│   └── k8s/              # Configurations Kubernetes
+│
+└── svelteFrontEnd/        # Frontend Svelte
+    ├── src/              # Code source
+    ├── static/           # Ressources statiques
+    └── electron.mjs      # Configuration Electron
+```
+
+## Choix de la Stack Technique
+
+### Pourquoi .NET pour le Backend ?
+- **Performance et Scalabilité** : .NET est reconnu pour ses performances exceptionnelles et sa capacité à gérer des charges élevées, crucial pour un forum avec de nombreux utilisateurs simultanés
+- **Entity Framework Core** : Offre une gestion efficace des données avec des capacités de mise en cache avancées et une optimisation des requêtes
+- **Support natif de l'asynchrone** : Permet de gérer efficacement les opérations concurrentes et d'optimiser l'utilisation des ressources
+- **Sécurité robuste** : Intégration native avec des fonctionnalités de sécurité avancées pour protéger les données des utilisateurs
+- **Conteneurisation** : Support natif de Docker et Kubernetes pour une scalabilité horizontale facile
+
+### Pourquoi Svelte pour le Frontend ?
+- **Performance** : Svelte compile le code en JavaScript vanilla ultra-optimisé, offrant des performances supérieures aux frameworks traditionnels
+- **Taille réduite** : Le bundle final est plus léger, ce qui améliore les temps de chargement et l'expérience utilisateur
+- **Réactivité** : Gestion efficace des mises à jour du DOM, cruciale pour un forum avec des mises à jour en temps réel
+- **Electron** : Permet de créer une application de bureau native tout en réutilisant le code web, offrant une expérience utilisateur cohérente
+- **SEO-friendly** : Facilite l'indexation du contenu du forum par les moteurs de recherche
+
+### Architecture Scalable
+- **Microservices** : Architecture modulaire permettant une scalabilité indépendante des composants
+- **Load Balancing** : Distribution intelligente de la charge entre les serveurs
+- **Caching** : Mise en cache à plusieurs niveaux pour optimiser les performances
+- **Monitoring** : Outils de surveillance en temps réel pour détecter et résoudre les goulots d'étranglement
+
+
+## Contribution
+
+1. Fork le projet
+2. Créez une branche pour votre fonctionnalité
+3. Committez vos changements
+4. Poussez vers la branche
+5. Ouvrez une Pull Request
+
+## Licence
+
+Ce projet est sous licence libre.