You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
League-of-Legends_Project/README.md

98 lines
3.4 KiB

![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**
<div align = center>
![Comment cloner](doc/Images/HowToClone.png)
</div>
- ### 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)
**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 ?
</br>
## Versioning
</br>
## RoadMap
**Récapitulation de notre avancée sur le projet** : 👇
</br>
:information_source: ...
- [x] &nbsp; ![Dto](./)
- [x] &nbsp; ![Mappeur](./)
* Toutes les donnée que expose l'Api sont des DTO mapper ces mapper [**Mappeur**](./).
- [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**](./).
- [x] &nbsp; ![Manager EF](./)
- [x] &nbsp; ![Test Unitaires EF](./)
- [x] &nbsp; ![Test Unitaires Api](./)
- [x] &nbsp; ![Versioning](./)
- [x] &nbsp; ![Controller](./)
- [x] &nbsp; ![Liason Bdd](./)
- [x] &nbsp; ![Client Console](./)
- [] &nbsp; ![Client MAUI http](./)
- [x] &nbsp; ![Déploiment & Hébergement Docker](./drone/yml)
* (:information_source: accéssible à cette **url** : https://codefirst.iut.uca.fr/containers/arthurvalin-lolcontainer/api )
</br>
### Autheurs
<div align = center>
* **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)
<div align="center">
<a href = "https://codefirst.iut.uca.fr/git/arthur.valin">
<img src="https://codefirst.iut.uca.fr/git/avatars/041c57af1e1d1e855876d8abb5f1c143?size=870" width="50" >
</a>
<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" >
</a>
</div>
© PM2
</div>