Giovanni/SAE-BUT2-docker
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

add naming part in README

Browse Source
This commit is contained in:
Giovanni
2026-03-29 15:03:56 +02:00
parent 1b99bb27c3
commit bd20bf7b6e
1 changed files with 69 additions and 55 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+69 -55
View File
@@ -1,29 +1,29 @@
# Gestion des bénévoles - Comité des fêtes de Beaupont # Gestion des bénévoles - Comité des fêtes de Beaupont
## Présentation du projet ## Présentation du projet
L'association organise régulièrement des événements et projets mobilisant des bénévoles, mais sa coordination interne est rendue difficile par l'usage d'outils dispersés, et non communicants. L'association organise régulièrement des événements et projets mobilisant des bénévoles, mais sa coordination interne est rendue difficile par l'usage d'outils dispersés, et non communicants.
La création d'une plateforme web unique vise donc à centraliser et simplifier la gestion des utilisateurs, des rôles, des événements, des tâches et de la communication. Elle vise à améliorer la collaboration entre tous les bénévoles de l'association. La création d'une plateforme web unique vise donc à centraliser et simplifier la gestion des utilisateurs, des rôles, des événements, des tâches et de la communication. Elle vise à améliorer la collaboration entre tous les bénévoles de l'association.
## Objectifs de l’application ## Objectifs de l’application
L’application a pour objectifs principaux de : L’application a pour objectifs principaux de :
- Gérer les utilisateurs et leurs rôles au sein de l’association. - Gérer les utilisateurs et leurs rôles au sein de l’association.
- Organiser et planifier les événements et les tâches associées. - Organiser et planifier les événements et les tâches associées.
- Permettre aux bénévoles de s’inscrire en ligne aux événements et aux tâches. - Permettre aux bénévoles de s’inscrire en ligne aux événements et aux tâches.
- Offrir aux responsables un tableau de bord pour suivre la participation et les besoins en ressources humaines. - Offrir aux responsables un tableau de bord pour suivre la participation et les besoins en ressources humaines.
- Centraliser les informations et la communication autour des projets associatifs. - Centraliser les informations et la communication autour des projets associatifs.
## Initialisation du projet ## Initialisation du projet
### 1. Configuration du fichier `.env` principal ### 1. Configuration du fichier `.env` principal
1. Créez un fichier `.env` à la racine du projet. 1. Créez un fichier `.env` à la racine du projet.
2. Copiez le contenu du fichier `.env.example` dans le fichier `.env`. 2. Copiez le contenu du fichier `.env.example` dans le fichier `.env`.
3. Renseignez les variables suivantes : 3. Renseignez les variables suivantes :
| Variable | Description | | Variable | Description |
| --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `BACKEND_GIT_REPO` | URL HTTPS du dépôt backend sans le préfixe `https://` <br>(ex : `gitlab.com/user/repo-backend.git`) | | `BACKEND_GIT_REPO` | URL HTTPS du dépôt backend sans le préfixe `https://` <br>(ex : `gitlab.com/user/repo-backend.git`) |
@@ -41,40 +41,54 @@ L’application a pour objectifs principaux de :
| `FORCE_CLONE` | Mettre à `true` pour forcer le clonage du dépôt backend même si la branche configurée diffère de la branche actuelle. | | `FORCE_CLONE` | Mettre à `true` pour forcer le clonage du dépôt backend même si la branche configurée diffère de la branche actuelle. |
| `DEV` | Mettre `1` en environnement de développement, laisser vide sinon. | | `DEV` | Mettre `1` en environnement de développement, laisser vide sinon. |
| `VITE_API_URL` | URL du frontend hébergé et exposé par le conteneur Nginx (par défaut sur le port 80) | | `VITE_API_URL` | URL du frontend hébergé et exposé par le conteneur Nginx (par défaut sur le port 80) |
### 2. Configuration du fichier `.env` php ### 2. Configuration du fichier `.env` php
Répétez la même opération pour le fichier `docker/php/.env` en copiant depuis `docker/php/.env.example`. Répétez la même opération pour le fichier `docker/php/.env` en copiant depuis `docker/php/.env.example`.
De plus, un utilisateur administrateur est automatiquement créé avec les informations suivantes : De plus, un utilisateur administrateur est automatiquement créé avec les informations suivantes :
- **Prénom :** `admin` - **Prénom :** `admin`
- **Nom :** `admin` - **Nom :** `admin`
- **Adresse e-mail :** `admin@mail.com` - **Adresse e-mail :** `admin@mail.com`
- **Mot de passe :** `admin` - **Mot de passe :** `admin`
- **Numéro de téléphone :** `0909090909` - **Numéro de téléphone :** `0909090909`
> Il est bien sûr possible de modifier ces valeurs dans le fichier ``docker/php/.env`` avant le premier lancement du seeder, en utilisant les variables : ``ADMIN_NAME``, ``ADMIN_LASTNAME``, ``ADMIN_MAIL``, ``ADMIN_PASSWORD``et ``ADMIN_PHONE_NUMBER`` > Il est bien sûr possible de modifier ces valeurs dans le fichier ``docker/php/.env`` avant le premier lancement du seeder, en utilisant les variables : ``ADMIN_NAME``, ``ADMIN_LASTNAME``, ``ADMIN_MAIL``, ``ADMIN_PASSWORD``et ``ADMIN_PHONE_NUMBER``
## Installation et lancement
### 3. Note importante
Une fois la configuration terminée :
> ⚠️ Si vous êtes sous **Windows**, assurez-vous que tous les fichiers `.sh` utilisent des fins de ligne **LF** et non **CRLF**, sous peine d’erreurs lors de l’exécution des scripts.
1. Ouvrez un terminal.
2. Placez-vous à la racine du projet. ## Installation et lancement
3. Exécutez les commandes suivantes dans l'ordre :
Une fois la configuration terminée :
1. Ouvrez un terminal.
2. Placez-vous à la racine du projet.
3. Exécutez les commandes suivantes dans l'ordre :
```bash ```bash
docker compose down -v docker compose down -v
``` ```
> Arrête et supprime les conteneurs existants ainsi que les volumes associés. > Arrête et supprime les conteneurs existants ainsi que les volumes associés.
> Cette étape permet de repartir sur une base propre. > Cette étape permet de repartir sur une base propre.
```bash ```bash
compose up --build -d compose up --build -d
``` ```
> Reconstruit les images Docker et démarre l’ensemble des services en arrière-plan. > Reconstruit les images Docker et démarre l’ensemble des services en arrière-plan.
## Note importante ## Point technique
> ⚠️ Si vous êtes sous **Windows**, assurez-vous que tous les fichiers `.sh` utilisent des fins de ligne **LF** et non **CRLF**, sous peine d’erreurs lors de l’exécution des scripts. ### 1. Le nommage
Nous avons adopté une convention de nommage en **camelCase** pour les variables, fonctions et fichiers JavaScript côté frontend.
Pour les composants React, nous utilisons la convention **PascalCase** afin de les différencier des éléments HTML.
Côté backend (Laravel), nous respectons les conventions PHP :
- **camelCase** pour les variables et méthodes
- **PascalCase** pour les classes (Controllers, Models, Policies, etc.)
Les noms sont choisis de manière explicite et descriptive afin de faciliter la compréhension du code et sa maintenance.