From fe8d292f9e0689ac83b2c34e948ce7defefd73e5 Mon Sep 17 00:00:00 2001 From: David D'ALMEIDA Date: Sun, 26 Mar 2023 12:57:03 +0200 Subject: [PATCH] =?UTF-8?q?Mise=20=C3=A0=20jour=20de=20'README.md'?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 127 ++++++++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 113 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 6d32ff6..a720667 100644 --- a/README.md +++ b/README.md @@ -1,98 +1,197 @@ + ![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   + -# 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. +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** + + +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 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 : ... +- ### 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 + +# 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) + + +![Schéma d'architecture général du projet](./doc/images/LOLProjet_Diagram.png) + + **Schéma des différentes tables présentes au sein de la base de données** + --- + ![Modèle de données](./doc/images/MLD.png) + + - ### Comment ça marche au niveau du code ? + +
+ + ## Versioning +Notre Api Rest est atteignable à ces deux Url ci-dessous il + +* V1 - Ne drevrait pas être contacter et ne dipose pas de toutes les fonctionalitées - [V1](https://codefirst.iut.uca.fr/containers/arthurvalin-lolcontainer/api/v1/) + +* **V2** - C'est sur cette URL que il faut contacté l'API - [V2](https://codefirst.iut.uca.fr/containers/arthurvalin-lolcontainer/api/v2/) + +
+ + ## RoadMap + **Récapitulation de notre avancée sur le projet** : 👇 + +
-:information_source: ... + + +:information_source:  ... + + - [x]   ![Dto](./) + - [x]   ![Mappeur](./) -* Toutes les donnée que expose l'Api sont des DTO mapper ces mapper [**Mappeur**](./). + +* Toutes les donnée que expose l'Api sont des DTO mapper par ces mapper [**Mappeur**](./). + - [x]   ![Code de Retour](./) -* Les reponce de l'Api rectect les normes de codes de retour vous pouvez retrouvez ici un tableau les récapitulant [**Code de Retour**](./). + +* Les reponce de l'Api respect les normes de codes de retour vous pouvez retrouvez ici un tableau les récapitulant [**Code de Retour**](./). + - [x]   ![Manager EF](./) + - [x]   ![Test Unitaires EF](./) + - [x]   ![Test Unitaires Api](./) + - [x]   ![Versioning](./) + - [x]   ![Controller](./) + + * Toutes les opération Crud on été réaliser avec l'inclusion de reponce HATEOS. + - [x]   ![Liason Bdd](./) + - [x]   ![Client Console](./) -- []   ![Client MAUI http](./) -- [x]   ![Déploiment & Hébergement Docker](./drone/yml) - * (:information_source: accéssible à cette **url** : https://codefirst.iut.uca.fr/containers/arthurvalin-lolcontainer/api ) + +- [x]   ![Client MAUI http](./) + + * Etant donné que on ne pouvait pas faire compiler le client sans les dépendances on à fait le Client en console vous pouvez le retrouvez ici - De plus étant donné que le model client est le même que ceului api, il était logique d'utiliser les même mappeur et les DTO c'est pour sa que le cient à la référence au Mappeur API et au DTO API [**Bibliothèque du Client http **](./). + +- [x]   ![Déploiment & Hébergement Docker](./drone/yml) +
+ + ### Autheurs + +
+ + * **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