update README to add default admin user
This commit is contained in:
@@ -2,43 +2,55 @@
|
|||||||
|
|
||||||
## 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|
|
||||||
| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|---|---|
|
||||||
| `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). |
|
|`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://`. |
|
|`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://`. |
|
|`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. |
|
|`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. |
|
|`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`
|
De plus, un utilisateur administrateur est automatiquement créé avec les informations suivantes :
|
||||||
- `docker/frontend/.env` : Copier depuis `docker/frontend/.env.example`
|
- **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
|
## Installation et lancement
|
||||||
|
|
||||||
Une fois la configuration terminée :
|
Une fois la configuration terminée :
|
||||||
|
|
||||||
1. Ouvrez un terminal.
|
1. Ouvrez un terminal.
|
||||||
2. Placez-vous à la racine du projet.
|
2. Placez-vous à la racine du projet.
|
||||||
@@ -47,17 +59,17 @@ Une fois la configuration terminée :
|
|||||||
```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
|
||||||
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
|
## Note importante
|
||||||
|
|
||||||
> ⚠️ **Windows**
|
> ⚠️ **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.
|
> 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.
|
||||||
|
|||||||
@@ -77,3 +77,9 @@ SANCTUM_STATEFUL_DOMAINS=localhost,127.0.0.1,localhost:8000,localhost:5173
|
|||||||
|
|
||||||
TYPESENSE_CONNECTION=typesense
|
TYPESENSE_CONNECTION=typesense
|
||||||
TYPESENSE_API_KEY=
|
TYPESENSE_API_KEY=
|
||||||
|
|
||||||
|
ADMIN_NAME=
|
||||||
|
ADMIN_LASTNAME=
|
||||||
|
ADMIN_MAIL=
|
||||||
|
ADMIN_PASSWORD=
|
||||||
|
ADMIN_PHONE_NUMBER=
|
||||||
Reference in New Issue
Block a user