- Intial commit

README.md

@@ -0,0 +1,57 @@
+# BookNest
+
+## Stack technique
+- Symfony 7.0
+- PHP 8.3
+- MariaDB 10
+- Nginx 
+
+## Installation
+
+### Création du fichier .env
+Le plus simple est de dupliquer le fichier .env.example et de le renommer en .env, et eventuellement de modifier les variables d'environnement si besoin
+```bash
+cp .env.example .env
+```
+
+### Build de l'image PHP
+```bash
+sudo docker compose build
+```
+
+### Installation des dépendances
+```bash
+sudo docker compose run --rm php composer install
+```
+
+## Demarrage du serveur de dev local
+```bash
+sudo docker compose up -d
+```
+
+## Lancer des commandes symfony
+Le bundle maker est installer dans le projet. Il permet de générer des fichiers de configuration, des entités, des controllers, etc...
+
+Commande pour voir la liste des make disponible
+```bash
+docker compose run --rm php bin/console make
+```
+
+## Lancer les linters
+Nous avons dans ce projets 3 linters: phpstan, phpcs et eslint.
+Pour les lancer il faut utiliser les commandes suivantes:
+```bash
+docker compose run --rm php composer run-script phpstan
+docker compose run --rm php composer run-script phpcs
+docker compose run --rm vite npm run lint
+```  
+Il existe également 2 commandes pour corriger automatiquement les erreurs de phpcs et eslint
+```bash
+docker compose run --rm php composer run-script phpcs:fix
+docker compose run --rm vite npm run lint:fix
+```
+
+Les différente documentation des linters:   
+- phpstan : https://phpstan.org/
+- phpcs : https://github.com/squizlabs/PHP_CodeSniffer
+- eslint : https://eslint.org/