From 7ee4db637eed648de9d9ad172aae67f45d054280 Mon Sep 17 00:00:00 2001 From: Giovanni-Josserand Date: Wed, 11 Feb 2026 16:54:02 +0100 Subject: [PATCH] update README to add default admin user --- README.md | 58 +++++++++++++++++++++++++---------------- docker/php/.env.example | 6 +++++ 2 files changed, 41 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 205d4ae..a5318de 100644 --- a/README.md +++ b/README.md @@ -2,43 +2,55 @@ ## 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 -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. - 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. 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`. +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
(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. | +|Variable|Description| +|---|---| +|`GIT_TOKEN`|Token GitLab à générer depuis Préférences → User settings → Personal access tokens
(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 des fichiers `.env` Docker +### 2. Configuration du fichier `.env` php -Répétez la même opération pour les fichiers suivants : +Répétez la même opération pour le fichier `docker/php/.env` en copiant depuis `docker/php/.env.example`. -- `docker/php/.env` : Copier depuis `docker/php/.env.example` -- `docker/frontend/.env` : Copier depuis `docker/frontend/.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 : +Une fois la configuration terminée : 1. Ouvrez un terminal. 2. Placez-vous à la racine du projet. @@ -47,17 +59,17 @@ Une fois la configuration terminée : ```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 +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 -> ⚠️ **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. +> ⚠️ **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. diff --git a/docker/php/.env.example b/docker/php/.env.example index d3b85cf..e472f8c 100644 --- a/docker/php/.env.example +++ b/docker/php/.env.example @@ -77,3 +77,9 @@ SANCTUM_STATEFUL_DOMAINS=localhost,127.0.0.1,localhost:8000,localhost:5173 TYPESENSE_CONNECTION=typesense TYPESENSE_API_KEY= + +ADMIN_NAME= +ADMIN_LASTNAME= +ADMIN_MAIL= +ADMIN_PASSWORD= +ADMIN_PHONE_NUMBER= \ No newline at end of file