diff --git a/README.md b/README.md index 5a4adec..22280bc 100644 --- a/README.md +++ b/README.md @@ -2,16 +2,43 @@ ![League Of Legends](./doc/images/LoL_Banner.png) --- +## Répartition du Git +La racine de notre git est composée de deux dossiers essentiels au projet: +[**src**](src) : **Toute la partie code de l'application** (ne contient que le serveur TypeScript à l'heure actuelle sans l'implémentation du service de mail) + +[**doc**](doc) : **Documentation de l'application** vous pourez y retrouvez nos différents Schéma et divers documentation + # Contexte + Ce projet consiste en une API web reliée à une base de donnée SQLite permettant d'avoir accès à différentes données relatives à League of Legends, par exemple les différents champions. Une application MAUI est également disponible. + +## Get Started +- ### Prerequis + +You need to have a configured Asp.net Core Entity Framework Core 2.+ environement. + +- ### Instalation + +Tout d'abord si ce n'est pas fait cloner le dépôt de la branche **master**, pour cela copier le lien URL du dépôt git :**git clone https://codefirst.iut.uca.fr/git/arthur.valin/League-of-Legends_Project.git** + +
+ +![Comment cloner](doc/Images/HowToClone.png) + +
+- ### Comment lancer le projet ? + +Ensuite dans un terminal, assurer vous que vous possédez les dépendances nécéssaire , pour cela : ... +👉 [**Solution de l'application**](src//.sln) # Fonctionnement Le projet est entièrement développé en .NET, principalement .NET6 mis-à-part le client MAUI développé en .NET7. La partie base de données en gérée par l'ORM Entity Framework. L'API permet d'effectuer des opérations CRUD sur les données. **Schéma général du projet** --- + ![Schéma général du projet](./doc/images/LOLProjet_Diagram.png) @@ -19,11 +46,47 @@ Le projet est entièrement développé en .NET, principalement .NET6 mis-à-part --- ![Modèle de données](./doc/images/MLD.png) +- ### Comment ça marche au niveau du code ? +
+ +## Versioning + +
+ +## RoadMap +**Récapitulation de notre avancée sur le projet** : 👇 + +
+ +:information_source: ... + +- [x]   ![Dto](./) +- [x]   ![Mappeur](./) +- [x]   ![Manager EF](./) +- [x]   ![Test EF](./) +- [x]   ![Manager Api](./) +- [x]   ![Controller](./) +- [x]   ![Client Console http](./) +- [x]   ![Client MAUI http](./) + +
+ +### Autheurs +
-arthur.valin@etu.uca.fr -david.d_almeida@etu.uca.fr +* **Arthur Valin** - *arthur.valin@etu.uca.fr* - [arthur](https://codefirst.iut.uca.fr/git/arthur.valin) +* **David d'Almeida** - *david.d_almeida@etu.uca.fr* - [david](https://codefirst.iut.uca.fr/git/david.d_almeida) +
+ + + + + + + +
© PM2
\ No newline at end of file