# Gestion des bénévoles - Comité des fêtes de Beaupont
## Initialisation
## Présentation du projet
Afin d'initialiser le projet il est requis de :
- Créer un fichier ``.env`` à la racine du projet
- Copier coller le contenu du fichier ``.env.example`` dans ce ``.env``
- Remplir les variables du fichier ``.env`` :
- ``GIT_TOKEN`` : chercher/générer son token sur gitlabdans l'onglet : ``Préférences/User settings/Personal access tokens`` (si vous devez le générer, ne pas oublier de cocher la case ``read_repository``)
- ``BACKEND_GIT_REPO`` et ``FRONTEND_GIT_REPO`` : récupérer l'adresse https des dépôts et enlever au début des liens ``https://``
- Répéter l'opération pour le ``docker/php/.env`` avec le ``docker/php/.env.example``
- Faire de même pour le ``docker/frontend/.env`` avec le ``docker/php/.env.example``
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.
## Objectifs de l’application
L’application a pour objectifs principaux de :
-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.
- 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.
- Centraliser les informations et la communication autour des projets associatifs.
## Initialisation du projet
### 1. Configuration du fichier `.env` principal
1. Créez un fichier `.env` à la racine du projet.
2. Copiez le contenu du fichier `.env.example` dans le fichier `.env`.
| `GIT_TOKEN` | Token GitLab à générer depuis Préférences → User settings → Personal access tokens (cocher la permission `read_repository`). |
| `BACKEND_GIT_REPO` | URL HTTPS du dépôt backend sans le préfixe `https://`. |
| `FRONTEND_GIT_REPO` | URL HTTPS du dépôt frontend sans le préfixe `https://`. |
| `DEV` | Mettre `1` en environnement de développement, laisser vide sinon. |
| `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. |
### 2. Configuration des fichiers `.env` Docker
Répétez la même opération pour les fichiers suivants :
-`docker/php/.env` : Copier depuis `docker/php/.env.example`
-`docker/frontend/.env` : Copier depuis `docker/frontend/.env.example`
## Installation et lancement
Une fois la configuration terminée :
1. Ouvrez un terminal.
2. Placez-vous à la racine du projet.
3. Exécutez les commandes suivantes :
## Installation
Il suffit ensuite d'ouvrir un terminal, de ce placer à la racine de ce projet et d'exécuter les commandes suivantes :
```bash
docker compose down -v
```
> Arrête et supprime les conteneurs existants ainsi que les volumes associés.
> Cette étape permet de repartir sur une base propre.
```bash
docker compose up --build -d
```
> Reconstruit les images Docker et démarre l’ensemble des services en arrière-plan.
> [!NOTE]
> Si vous êtes sur Windows, changer vos caractères de contrôles de ``CRLF`` à ``LF`` (pour chaque fichier ``.sh`` du projet)
## Note importante
> ⚠️ **Windows**
> 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.
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
