Keryloo - Gestion Locative

Application de gestion locative développée avec Spring Boot (backend) et React (frontend).

Vue d'Ensemble

Keryloo est une application complète de gestion locative conçue pour simplifier la gestion des propriétés immobilières, des contrats de location, des locataires et des échéances de loyer.

Fonctionnalités principales :

• Gestion des propriétés, bailleurs, locataires
• Gestion des baux et échéances de loyer
• Calcul automatique des loyers avec proratisation
• Génération de documents (quittances, avis d'échéances)
• Système d'audit complet et traçabilité
• Gestion électronique de documents (GED)

Quick Start (Développement Local)

Prérequis

• WSL2/Ubuntu 22.04+
• Docker (PostgreSQL + Keycloak)
• Java 21, Maven 3.9+
• Node.js 22+ avec npm

Installation Rapide

# Clone du projet
git clone https://forgejo.dogonotes.fr/ronan/Keryloo.git
cd Keryloo

# Rendre exécutables les scripts
chmod u+x run-*.sh

# Lancer backend + Docker services (Terminal 1)
./run-back.sh

# Lancer frontend (Terminal 2)
./run-front.sh

Accédez à l'application : http://localhost:5173

Pour l'installation détaillée, consultez le Guide d'Installation.

Stack Technologique

Composant	Technologies
Backend	Spring Boot 3.5.7, Java 21, PostgreSQL 17.2, Keycloak OAuth2
Frontend	React 18, TypeScript, Vite 7, Material-UI v5
Infrastructure	Docker Compose, Liquibase
Build	Maven 3.9+, npm

Documentation

• Guide d'Installation - Installation détaillée développement/local
• Architecture Technique - Architecture, patterns, choix techniques
• Guide Fonctionnel - Modules métier, API, cas d'usage
• Déploiement Production - Configuration production
• Contributing - Workflow, standards de code, rôles des agents

Contribution

Consultez 05-CONTRIBUTING.md pour :

• Workflow Git (feature/fix/tech branches → Merge Request → main)
• Standards de code backend/frontend
• Processus de Merge Request
• Rôles des 12 agents Claude Code

Structure du Projet

Keryloo/
├── keryloo-back/           # Backend Spring Boot
│   ├── src/main/java/com/keryloo/
│   │   ├── admin/          # Module administration
│   │   ├── audit/          # Module audit
│   │   ├── contractualization/  # Baux, propriétés, locataires
│   │   ├── payment/        # Loyers, paiements, quittances
│   │   ├── document_generation/ # Génération PDF
│   │   ├── ged/            # Gestion électronique documents
│   │   └── technical/      # Configuration, sécurité
│   └── src/main/resources/
│       └── db/changelog/   # Migrations Liquibase
├── keryloo-ui/             # Frontend React
│   ├── src/
│   │   ├── components/     # Composants réutilisables
│   │   ├── pages/          # Pages (routes)
│   │   └── services/       # Services API
│   └── package.json
├── keryloo-doc/            # Documentation centralisée
│   ├── 01-INSTALLATION.md
│   ├── 02-ARCHITECTURE_TECHNIQUE.md
│   ├── 03-GUIDE_FONCTIONNEL.md
│   ├── 04-DEPLOIEMENT_PRODUCTION.md
│   └── 05-CONTRIBUTING.md
├── .claude/agents/         # Agents Claude Code (12 agents)
├── run-back.sh             # Script lancement backend
├── run-front.sh            # Script lancement frontend
└── docker-compose.yml      # Services Docker

URLs Développement

• Frontend : http://localhost:5173
• Backend API : http://localhost:8080/api
• Swagger UI : http://localhost:8080/api/swagger-ui.html
• Keycloak Admin : http://localhost:8081 (admin/admin)
• PostgreSQL : localhost:5432 (postgres/password)

Support

Pour toute question ou problème :

• Consulter la documentation
• Vérifier les logs backend (console Spring Boot)
• Vérifier les logs frontend (console navigateur F12)
• Consulter les logs Docker : docker logs keryloo-postgres ou docker logs keryloo-keycloak

---

Dernière mise à jour : 2025-12-25