docs: mise à jour du README.md
- Remplacement de PostgreSQL par Docker dans les prérequis pour inclure les services liés (PostgreSQL et Mailpit). - Ajout d'une section sur la structure des dossiers pour mieux documenter l'organisation du projet.
This commit is contained in:
24
README.md
24
README.md
@@ -21,7 +21,7 @@ Cette base est conçue pour évoluer et intégrer de nouveaux outils et fonction
|
|||||||
- **PHP** 8.4 ou supérieur
|
- **PHP** 8.4 ou supérieur
|
||||||
- **[Composer](https://getcomposer.org/download/)** : (Gestionnaire de dépendances PHP)
|
- **[Composer](https://getcomposer.org/download/)** : (Gestionnaire de dépendances PHP)
|
||||||
- **[Symfony CLI](https://getcomposer.org/download/)** (Interface en ligne de commande Symfony)
|
- **[Symfony CLI](https://getcomposer.org/download/)** (Interface en ligne de commande Symfony)
|
||||||
- **PostgreSQL** (Système de gestion de base de données)
|
- **Docker** Permet de lancer les services lié: postgres (base de données), mailpit (serveur de messagerie pour le dev)
|
||||||
- **IDE recommandé** : PhpStorm ou VSCode
|
- **IDE recommandé** : PhpStorm ou VSCode
|
||||||
|
|
||||||
Vérifier les prérequis : ```symfony check:requirements```
|
Vérifier les prérequis : ```symfony check:requirements```
|
||||||
@@ -65,5 +65,27 @@ symfony serve -d
|
|||||||
```
|
```
|
||||||
L'application sera accessible sur `https://127.0.0.1:8000`.
|
L'application sera accessible sur `https://127.0.0.1:8000`.
|
||||||
|
|
||||||
|
## Structure des dossiers
|
||||||
|
|
||||||
|
```
|
||||||
|
.
|
||||||
|
├── assets/
|
||||||
|
│ ├── controllers/ # JS
|
||||||
|
│ ├── styles/ # CSS
|
||||||
|
│ └── images/ # Images du site
|
||||||
|
├── public/ # Fichiers publics directs
|
||||||
|
└── templates/
|
||||||
|
├── _partials/ # TODO: _navbar.html.twig, _footer.html.twig...
|
||||||
|
├── bundles/
|
||||||
|
│ └── TwigBundle/
|
||||||
|
│ └── Exception/
|
||||||
|
│ ├── error404.html.twig
|
||||||
|
│ ├── error500.html.twig
|
||||||
|
│ └── error.html.twig
|
||||||
|
├── user/ # Correspond à UserController
|
||||||
|
│ └── index.html.twig
|
||||||
|
└── base.html.twig # Layout principal
|
||||||
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
*Projet développé pour KAZ.*
|
*Projet développé pour KAZ.*
|
||||||
Reference in New Issue
Block a user