76 lines
3.4 KiB
Markdown
76 lines
3.4 KiB
Markdown
# Gestion des bénévoles - Comité des fêtes de Beaupont
|
||
|
||
## 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.
|
||
|
||
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`.
|
||
3. Renseignez les variables suivantes :
|
||
|
||
|Variable|Description|
|
||
|---|---|
|
||
|`GIT_TOKEN`|Token GitLab à générer depuis Préférences → User settings → Personal access tokens <br>(cocher la permission `read_repository`, cocher la permission `write_repository` si vous êtes en développement).|
|
||
|`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 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`.
|
||
|
||
De plus, un utilisateur administrateur est automatiquement créé avec les informations suivantes :
|
||
- **Prénom :** `admin`
|
||
- **Nom :** `admin`
|
||
- **Adresse e-mail :** `admin@gmail.com`
|
||
- **Mot de passe :** `12345678`
|
||
- **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``
|
||
|
||
|
||
### 3. Configuration du fichier `.env` frontend
|
||
Répétez la même opération pour le fichier `docker/frontend/.env` en copiant depuis `frontend/php/.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 :
|
||
|
||
```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
|
||
compose up --build -d
|
||
```
|
||
|
||
> Reconstruit les images Docker et démarre l’ensemble des services en arrière-plan.
|
||
|
||
## 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.
|