From b7d1df2fbb529217180f86d7687024bc9c58fd8c Mon Sep 17 00:00:00 2001 From: Arthur VALIN Date: Sun, 26 Mar 2023 15:04: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 | 33 ++++++++++++++++----------------- 1 file changed, 16 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index a720667..573db4e 100644 --- a/README.md +++ b/README.md @@ -29,19 +29,18 @@ Ce projet consiste en une API web reliée à une base de donnée SQLite permetta ## Get Started -- ### Prerequis +- ### Prérequis -You need to have a configured Asp.net Core Entity Framework Core 2.+ environement. +Vous devez disposer d'un environnement Asp.net Core Entity Framework Core 2.+ configuré. -- ### Instalation +- ### Installation - - -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, clonez le dépôt de la branche **master**, pour cela copiez le lien URL du dépôt git : +```git clone https://codefirst.iut.uca.fr/git/arthur.valin/League-of-Legends_Project.git``` @@ -59,7 +58,7 @@ Tout d'abord si ce n'est pas fait cloner le dépôt de la branche **master**, po -Ensuite dans un terminal, assurer vous que vous possédez les dépendances nécéssaire , pour cela  : ... +Ensuite, dans un terminal, assurez-vous que vous possédez les dépendances nécessaires, pour cela : ... 👉 [**Solution de l'application**](src//.sln) @@ -97,13 +96,13 @@ Le projet est entièrement développé en .NET, principalement .NET6 mis-à-part -## Versioning +## Versionning -Notre Api Rest est atteignable à ces deux Url ci-dessous il +Notre API REST est atteignable à ces deux URIs ci-dessous : -* 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/) +* V1 - Ne dois pas être contactée et ne dispose pas de toutes les fonctionnalités - [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/) +* **V2** - C'est sur cette URI que il faut contacter l'API - [V2](https://codefirst.iut.uca.fr/containers/arthurvalin-lolcontainer/api/v2/)
@@ -112,7 +111,7 @@ Notre Api Rest est atteignable à ces deux Url ci-dessous il ## RoadMap -**Récapitulation de notre avancée sur le projet** : 👇 +**Récapitulatif de notre avancée sur le projet** : 👇 @@ -128,11 +127,11 @@ Notre Api Rest est atteignable à ces deux Url ci-dessous il - [x]   ![Mappeur](./) -* Toutes les donnée que expose l'Api sont des DTO mapper par ces mapper [**Mappeur**](./). +* Toutes les données qu'expose l'API sont des DTOs mappés par ces mapper [**Mappeur**](./). - [x]   ![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**](./). +* Les réponse de l'API respectent les normes de code de retour. Vous pouvez retrouver ici un tableau les récapitulant [**Code de Retour**](./). - [x]   ![Manager EF](./) @@ -144,7 +143,7 @@ Notre Api Rest est atteignable à ces deux Url ci-dessous il - [x]   ![Controller](./) - * Toutes les opération Crud on été réaliser avec l'inclusion de reponce HATEOS. + * Toutes les opérations crud on été réalisées avec l'inclusion de réponse HATEOS. - [x]   ![Liason Bdd](./) @@ -152,7 +151,7 @@ Notre Api Rest est atteignable à ces deux Url ci-dessous il - [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 **](./). + * Etant donné que l'on ne pouvait pas faire compiler le client sans les dépendances, nous avons 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) @@ -160,7 +159,7 @@ Notre Api Rest est atteignable à ces deux Url ci-dessous il -### Autheurs +### Auteurs