add naming part in README

This commit is contained in:
2026-03-29 15:03:56 +02:00
parent 1b99bb27c3
commit bd20bf7b6e
+16 -2
View File
@@ -54,6 +54,11 @@ Répétez la même opération pour le fichier `docker/php/.env` en copiant depu
- **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. 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 derreurs lors de lexécution des scripts.
## Installation et lancement
Une fois la configuration terminée :
@@ -75,6 +80,15 @@ compose up --build -d
> Reconstruit les images Docker et démarre lensemble 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 derreurs lors de lexé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.