From c1ca3b9b44bd836729844141b41e7374d78d5499 Mon Sep 17 00:00:00 2001 From: MLeveque Date: Sun, 22 Feb 2026 19:38:21 +0100 Subject: [PATCH] docs: ajout du fichier README.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Présentation de la plateforme web pour les adhérents KAZ. - Détails sur les fonctionnalités, l'architecture technique et les prérequis. - Instructions pour l'installation et le démarrage rapide du projet. - Normes de développement documentées. --- README.md | 69 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 69 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..fa39a14 --- /dev/null +++ b/README.md @@ -0,0 +1,69 @@ + +# Plateforme web pour les adhérents KAZ + +## Objectif +Cette application web permet aux adhérents de l'association KAZ de gérer leur compte en agrégeant les données des utilisateurs dispersées dans plusieurs outils de l'écosystème. + +## Fonctionnalités (Version 1) +- **Connexion sécurisée** : Accès réservé aux adhérents à l'administration. +- **Visualisation des données** : Affichage des informations personnelles de l'utilisateur. +- **Modification du profil** : Possibilité de changer l'adresse e-mail de secours. + +## Architecture technique +- **Frontend** : [Twig](https://twig.symfony.com/) + [Tailwind CSS](https://tailwindcss.com/) +- **Backend** : PHP 8.4 / [Symfony](https://symfony.com/) +- **Base de données** : [PostgreSQL](https://www.postgresql.org/) +- **Intégration** : Communication via API avec les outils de KAZ (notamment OpenLDAP). + +Cette base est conçue pour évoluer et intégrer de nouveaux outils et fonctionnalités à l'avenir. + +## Prérequis +- **PHP** 8.4 ou supérieur +- **[Composer](https://getcomposer.org/download/)** : (Gestionnaire de dépendances PHP) +- **[Symfony CLI](https://getcomposer.org/download/)** (Interface en ligne de commande Symfony) +- **PostgreSQL** (Système de gestion de base de données) +- **IDE recommandé** : PhpStorm ou VSCode + +Vérifier les prérequis : ```symfony check:requirements``` + +## Normes de développement +Le projet suit les standards de développement suivants : +- **[Git Flow](https://git-flow.readthedocs.io/fr/latest/presentation.html)** : Modèle de gestion de branches. +- **[Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)** : Norme pour les messages de commit. + +## Quick start + +### 1. Installation des dépendances +Clonez le projet et installez les dépendances avec Composer : +```bash +composer install +``` + +### 2. Configuration de l'environnement +Copiez le fichier `.env` en `.env.local` et configurez vos accès à la base de données et à l'API : +```bash +cp .env .env.local +``` + +### 3. Base de données +Créez la base de données et exécutez les migrations : +```bash +php bin/console doctrine:database:create +php bin/console doctrine:migrations:migrate +``` + +### 4. Installation des assets +Le projet utilise AssetMapper. Installez les dépendances JS : +```bash +php bin/console importmap:install +``` + +### 5. Lancement du serveur +Utilisez le serveur Symfony pour lancer le projet localement : +```bash +symfony serve -d +``` +L'application sera accessible sur `https://127.0.0.1:8000`. + +--- +*Projet développé pour KAZ.*