Update README.md

README.md

@@ -1,4 +1,82 @@
 
+# TaskFlow 📌
+
+Task FLow est un outil de gestion de projet, il est possible de créer des projets ainsi que d'assigner des tâches à un utilisateur.
+
+Cet outil a été réalisé en Express (backend) et Vue (frontend).
+
+Projet d'école :  https://nowledgeable.com/student/courses/1653
+
+## Features
+
+- __Projet__ : 
+    - Créer un projet ;
+    - Supprimer un projet ; 
+    - Afficher la liste des projets ; 
+    - Afficher les détails d'un projet ;
+
+- __Tâche__ : 
+    - Créer une tâche ;
+    - Supprimer une tâche ; 
+    - Afficher la liste des tâches appartenant à un projet ; 
+
+- __Authentification__ : 
+    - S'inscrire ;
+    - Se connecter ;
+    - Se déconnecter
+
+## Getting Started
+
+Cloner le projet : 
+```bash
+git clone https://github.com/armanceau/TaskFlow.git
+```
+
+Se déplacer dans le projet : 
+```bash
+cd TaskFlow
+```
+
+Lancer le backend : 
+```bash
+cd /backend
+npm install
+cd /src 
+node app.mjs
+```
+
+Lancer les tests du backend : 
+```bash
+cd /backend/tests 
+npm run test
+```
+
+Lancer le frontend : 
+```bash
+cd /frontend/my-app 
+npm install
+npm run dev
+```
+
+Lancer le frontend : 
+```bash
+cd /frontend/my-app 
+npm install
+npm run dev
+```
+
+Lancer les tests frontend : 
+```bash
+cd /frontend/my-app 
+npx vitest
+```
+
+Lancer les tests frontend cypress : 
+```bash
+cd /frontend/my-app 
+npm cypress open
+```
+
 ## API Reference
 
 #### Récupérer tous les projets
@@ -53,3 +131,10 @@
 | `description` | `string` |  |
 | `createur` | `string` |  |
 | `utilisateurAssigne` | `string` |  |
+
+## Author
+
+[@armanceau](https://www.github.com/armanceau)
+
+[![linkedin](https://img.shields.io/badge/linkedin-0A66C2?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/arthur-manceau/)
+