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
+22 -8
View File
@@ -46,14 +46,19 @@ L’application a pour objectifs principaux de :
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``
### 3. Note importante
> ⚠️ 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.
## Installation et lancement ## Installation et lancement
Une fois la configuration terminée : Une fois la configuration terminée :
@@ -75,6 +80,15 @@ 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.