Mise à jour de 'README.md'
continuous-integration/drone/push Build is passing Details

Doc
David D'ALMEIDA 2 years ago
parent 107237ae60
commit fe8d292f9e

@ -1,98 +1,197 @@
![League Of Legends](./doc/images/LoL_Banner.png) ![League Of Legends](./doc/images/LoL_Banner.png)
--- ---
## Répartition du Git ## Répartition du Git
La racine de notre git est composée de deux dossiers essentiels au projet: 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) [**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 [**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 ## Get Started
- ### Prerequis - ### Prerequis
You need to have a configured Asp.net Core Entity Framework Core 2.+ environement. You need to have a configured Asp.net Core Entity Framework Core 2.+ environement.
- ### Instalation - ### 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**  
<div align = center> <div align = center>
![Comment cloner](doc/Images/HowToClone.png)
![Comment cloner](doc/images/HowToClone.png)
</div> </div>
- ### 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) 👉 [**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. 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**
--- ---
![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** **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) ![Modèle de données](./doc/images/MLD.png)
- ### Comment ça marche au niveau du code ? - ### Comment ça marche au niveau du code ?
</br> </br>
## Versioning ## 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/)
</br> </br>
## RoadMap ## RoadMap
**Récapitulation de notre avancée sur le projet** : 👇 **Récapitulation de notre avancée sur le projet** : 👇
</br> </br>
:information_source: ...
:information_source:  ...
- [x] &nbsp; ![Dto](./) - [x] &nbsp; ![Dto](./)
- [x] &nbsp; ![Mappeur](./) - [x] &nbsp; ![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] &nbsp; ![Code de Retour](./) - [x] &nbsp; ![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] &nbsp; ![Manager EF](./) - [x] &nbsp; ![Manager EF](./)
- [x] &nbsp; ![Test Unitaires EF](./) - [x] &nbsp; ![Test Unitaires EF](./)
- [x] &nbsp; ![Test Unitaires Api](./) - [x] &nbsp; ![Test Unitaires Api](./)
- [x] &nbsp; ![Versioning](./) - [x] &nbsp; ![Versioning](./)
- [x] &nbsp; ![Controller](./) - [x] &nbsp; ![Controller](./)
 * Toutes les opération Crud on été réaliser avec l'inclusion de reponce HATEOS.
- [x] &nbsp; ![Liason Bdd](./) - [x] &nbsp; ![Liason Bdd](./)
- [x] &nbsp; ![Client Console](./) - [x] &nbsp; ![Client Console](./)
- [] &nbsp; ![Client MAUI http](./)
- [x] &nbsp; ![Déploiment & Hébergement Docker](./drone/yml) - [x] &nbsp; ![Client MAUI http](./)
* (:information_source: accéssible à cette **url** : https://codefirst.iut.uca.fr/containers/arthurvalin-lolcontainer/api )
 * 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] &nbsp; ![Déploiment & Hébergement Docker](./drone/yml)
</br> </br>
### Autheurs ### Autheurs
<div align = center> <div align = center>
* **Arthur Valin** - *arthur.valin@etu.uca.fr* - [arthur](https://codefirst.iut.uca.fr/git/arthur.valin) * **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) * **David d'Almeida** - *david.d_almeida@etu.uca.fr* - [david](https://codefirst.iut.uca.fr/git/david.d_almeida)
<div align="center"> <div align="center">
<a href = "https://codefirst.iut.uca.fr/git/arthur.valin"> <a href = "https://codefirst.iut.uca.fr/git/arthur.valin">
<img src="https://codefirst.iut.uca.fr/git/avatars/041c57af1e1d1e855876d8abb5f1c143?size=870" width="50" > <img src="https://codefirst.iut.uca.fr/git/avatars/041c57af1e1d1e855876d8abb5f1c143?size=870" width="50" >
</a> </a>
<a href = "https://codefirst.iut.uca.fr/git/david.d_almeida"> <a href = "https://codefirst.iut.uca.fr/git/david.d_almeida">
<img src="https://codefirst.iut.uca.fr/git/avatars/0f8eaaad1e26d3de644ca522eccaea7c?size=870" width="50" > <img src="https://codefirst.iut.uca.fr/git/avatars/0f8eaaad1e26d3de644ca522eccaea7c?size=870" width="50" >
</a> </a>
</div> </div>
© PM2 © PM2
</div> </div>
Loading…
Cancel
Save