docs: enrichissement du README.md #3

Merged
melvin-leveque merged 1 commits from docs/maj_documentation into main 2026-03-01 18:10:32 +01:00

View File

@@ -18,7 +18,7 @@ Cette application web permet aux adhérents de l'association KAZ de gérer leur
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
- **PHP** 8.4
- **[Composer](https://getcomposer.org/download/)** : (Gestionnaire de dépendances PHP)
- **[Symfony CLI](https://getcomposer.org/download/)** (Interface en ligne de commande Symfony)
- **Docker** Permet de lancer les services lié: postgres (base de données), mailpit (serveur de messagerie pour le dev)
@@ -31,34 +31,77 @@ 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.
### Procédure de contribution (Git Flow)
Toutes les modifications doivent passer par une branche dédiée avant d'être fusionnées dans la branche principal `main` via une Pull Request (Demande d'ajout).
#### Exemple d'ajout d'une fonctionnalité (feature)
1. **Mise à jour de l'environnement local** :
```bash
git checkout main
git pull origin main
```
2. **Création de la branche de fonctionnalité** (préfixe `feat/`) :
```bash
git checkout -b feat/nom-de-ma-feature
```
3. **Développement et commit** (respectant les Conventional Commits) :
```bash
git add .
git commit -m "feat: ajout de la nouvelle fonctionnalité"
```
4. **Publication de la branche** :
```bash
git push origin feat/nom-de-ma-feature
```
5. **Création de la Pull Request** : Rendez-vous sur Gitea pour ouvrir une PR de `feat/nom-de-ma-feature` vers `main`. Une fois revue et validée, elle sera fusionnée via l'interface.
#### Exemple de correction de bug (fix)
La procédure est identique, mais utilisez le préfixe `fix/` :
```bash
git checkout -b fix/nom-du-bug
# ... corrections ...
git commit -m "fix: résolution du problème"
git push origin fix/nom-du-bug
```
Pour les tâches de maintenance ou documentation, utilisez respectivement les préfixes `chore/` ou `docs/`.
## Quick start
### 1. Installation des dépendances
Clonez le projet et installez les dépendances avec Composer :
### 1. Clonage du projet
Clonez le projet en utilisant SSH :
```bash
git clone ssh://git@git.kaz.bzh:2202/melvin-leveque/interface-kaznautes.git
cd interface-kaznautes
```
### 2. Installation des dépendances
Installez les dépendances avec Composer :
```bash
composer install
```
### 2. Configuration de l'environnement
### 3. 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
### 4. 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
### 5. Installation des assets
Le projet utilise AssetMapper. Installez les dépendances JS :
```bash
php bin/console importmap:install
```
### 5. Lancement du serveur
### 6. Lancement du serveur
Utilisez le serveur Symfony pour lancer le projet localement :
```bash
symfony serve -d