📝 readme

README.md

@@ -0,0 +1,114 @@
+# Todo Application
+
+Application Todo développée avec Symfony.
+
+## Prérequis
+
+Avant de commencer, assurez-vous d'avoir installé les outils suivants :
+
+* PHP **>= 8.1**
+* Composer
+* Symfony CLI
+* Docker
+* Docker Compose
+
+Vérifiez vos installations :
+
+```bash
+php -v
+composer --version
+symfony -v
+docker --version
+docker compose version
+```
+
+## Installation
+
+Clonez le projet :
+
+```bash
+git clone ssh://git@gitea.raggaroth-factory.fr:2222/toucan_dev/php-nostalgic.git
+cd php-nostalgic
+```
+
+Installez les dépendances PHP :
+
+```bash
+composer install
+```
+
+## Démarrer les services Docker
+
+Lancez les services nécessaires (base de données, etc.) :
+
+```bash
+docker compose up
+```
+
+Pour lancer les services en arrière-plan :
+
+```bash
+docker compose up -d
+```
+
+## Initialiser la base de données
+
+Appliquez les migrations Doctrine :
+
+```bash
+php bin/console doctrine:migrations:migrate
+```
+
+## Démarrer le serveur Symfony
+
+Lancez l'application :
+
+```bash
+symfony server:start --port=3000
+```
+
+L'application est disponible à l'adresse :
+
+```
+GET http://127.0.0.1:3000/todo
+```
+
+## Arrêter l'environnement
+
+Arrêter le serveur Symfony :
+
+```bash
+CTRL+C
+```
+
+Arrêter les conteneurs Docker :
+
+```bash
+docker compose down
+```
+
+## Commandes utiles
+
+Voir l'état des services Docker :
+
+```bash
+docker compose ps
+```
+
+Voir les logs Docker :
+
+```bash
+docker compose logs -f
+```
+
+Vider le cache Symfony :
+
+```bash
+php bin/console cache:clear
+```
+
+Lancer les tests :
+
+```bash
+php bin/phpunit
+```