From 61524f2bb0ca7aaa8a29ddb7ff7c9de9bf1f5e57 Mon Sep 17 00:00:00 2001 From: Lucas DELANIER Date: Mon, 13 Mar 2023 16:09:50 +0100 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 | 213 ++++++++++++------------------------------------------ 1 file changed, 45 insertions(+), 168 deletions(-) diff --git a/README.md b/README.md index 3228583..ec4237c 100644 --- a/README.md +++ b/README.md @@ -1,168 +1,45 @@ -# prepaLoL - -## Diagramme de classes du modèle -```mermaid -classDiagram -class LargeImage{ - +/Base64 : string -} -class Champion{ - +/Name : string - +/Bio : string - +/Icon : string - +/Characteristics : Dictionary~string, int~ - ~ AddSkin(skin : Skin) bool - ~ RemoveSkin(skin: Skin) bool - + AddSkill(skill: Skill) bool - + RemoveSkill(skill: Skill) bool - + AddCharacteristics(someCharacteristics : params Tuple~string, int~[]) - + RemoveCharacteristics(label : string) bool - + this~label : string~ : int? -} -Champion --> "1" LargeImage : Image -class ChampionClass{ - <> - Unknown, - Assassin, - Fighter, - Mage, - Marksman, - Support, - Tank, -} -Champion --> "1" ChampionClass : Class -class Skin{ - +/Name : string - +/Description : string - +/Icon : string - +/Price : float -} -Skin --> "1" LargeImage : Image -Champion "1" -- "*" Skin -class Skill{ - +/Name : string - +/Description : string -} -class SkillType{ - <> - Unknown, - Basic, - Passive, - Ultimate, -} -Skill --> "1" SkillType : Type -Champion --> "*" Skill -class Rune{ - +/Name : string - +/Description : string -} -Rune --> "1" LargeImage : Image -class RuneFamily{ - <> - Unknown, - Precision, - Domination -} -Rune --> "1" RuneFamily : Family -class Category{ - <> - Major, - Minor1, - Minor2, - Minor3, - OtherMinor1, - OtherMinor2 -} -class RunePage{ - +/Name : string - +/this[category : Category] : Rune? - - CheckRunes(newRuneCategory : Category) - - CheckFamilies(cat1 : Category, cat2 : Category) bool? - - UpdateMajorFamily(minor : Category, expectedValue : bool) -} -RunePage --> "*" Rune : Dictionary~Category,Rune~ -``` - -## Diagramme de classes des interfaces de gestion de l'accès aux données -```mermaid -classDiagram -direction LR; -class IGenericDataManager~T~{ - <> - GetNbItems() Task~int~ - GetItems(index : int, count : int, orderingPropertyName : string?, descending : bool) Task~IEnumerable~T~~ - GetNbItemsByName(substring : string) - GetItemsByName(substring : string, index : int, count : int, orderingPropertyName : string?, descending : bool) Task~IEnumerable~T~~ - UpdateItem(oldItem : T, newItem : T) Task~T~~ - AddItem(item : T) Task~T~ - DeleteItem(item : T) Task~bool~ -} -class IChampionsManager{ - <> - GetNbItemsByCharacteristic(charName : string) - GetItemsByCharacteristic(charName : string, index : int, count : int, orderingPropertyName : string?, descending : bool) Task~IEnumerable~Champion?~~ - GetNbItemsByClass(championClass : ChampionClass) - GetItemsByClass(championClass : ChampionClass, index : int, count : int, orderingPropertyName : string?, descending : bool) Task~IEnumerable~Champion?~~ - GetNbItemsBySkill(skill : Skill?) - GetItemsBySkill(skill : Skill?, index : int, count : int, orderingPropertyName : string?, descending : bool) Task~IEnumerable~Champion?~~ - GetNbItemsBySkill(skill : string) - GetItemsBySkill(skill : string, index : int, count : int, orderingPropertyName : string?, descending : bool) Task~IEnumerable~Champion?~~ - GetNbItemsByRunePage(runePage : RunePage?) - GetItemsByRunePage(runePage : RunePage?, index : int, count : int, orderingPropertyName : string?, descending : bool) Task~IEnumerable~Champion?~~ -} -class ISkinsManager{ - <> - GetNbItemsByChampion(champion : Champion?) - GetItemsByChampion(champion : Champion?, index : int, count : int, orderingPropertyName : string?, descending : bool) Task~IEnumerable~Skin?~~ -} -class IRunesManager{ - <> - GetNbItemsByFamily(family : RuneFamily) - GetItemsByFamily(family : RuneFamily, index : int, count : int, orderingPropertyName : string?, descending : bool) Task~IEnumerable~Rune?~~ -} -class IRunePagesManager{ - <> - GetNbItemsByRune(rune : Rune?) - GetItemsByRune(rune : Rune?, index : int, count : int, orderingPropertyName : string?, descending : bool) Task~IEnumerable~RunePage?~~ - GetNbItemsByChampion(champion : Champion?) - GetItemsByChampion(champion : Champion?, index : int, count : int, orderingPropertyName : string?, descending : bool) Task~IEnumerable~RunePage?~~ -} - -IGenericDataManager~Champion?~ <|.. IChampionsManager : T--Champion? -IGenericDataManager~Skin?~ <|.. ISkinsManager : T--Skin? -IGenericDataManager~Rune?~ <|.. IRunesManager : T--Rune? -IGenericDataManager~RunePage?~ <|.. IRunePagesManager : T--RunePage? -class IDataManager{ - <> -} -IChampionsManager <-- IDataManager : ChampionsMgr -ISkinsManager <-- IDataManager : SkinsMgr -IRunesManager <-- IDataManager : RunesMgr -IRunePagesManager <-- IDataManager : RunePagesMgr -``` - -## Diagramme de classes simplifié du Stub -```mermaid -classDiagram -direction TB; - -IDataManager <|.. StubData - -ChampionsManager ..|> IChampionsManager -StubData --> ChampionsManager - -RunesManager ..|> IRunesManager -StubData --> RunesManager - -RunePagesManager ..|> IRunePagesManager -StubData --> RunePagesManager - -SkinsManager ..|> ISkinsManager -StubData --> SkinsManager - -StubData --> RunesManager -StubData --> "*" Champion -StubData --> "*" Rune -StubData --> "*" RunePages -StubData --> "*" Skins -``` \ No newline at end of file + + ## LOLProject + + + + +**LOLProject** est un projet reliant une api C# et entityframework afin de produire une API qui renvoie les infromations d'une base de données sqlLite sur un client MAUI + +## :floppy_disk: FEATURES + +L'api dispose de nombreux end point visible sur le swagger au moment du lancement. + + +![](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/rainbow.png) + +## :dizzy: Getting Started + +Une fois le dépot cloné, vous pouvez lancer le code sur votre téléphone Android grace a l'outil Android studio ou grace a un émulateur android. + + + + +## :wrench: SUPPORT +En cas de problème lors de l'utilisation de l'application, vous pouvez nous contacer aux adresses suivantes : + + +Lucas Delanier : **Lucas.Delanier@etu.uca.fr**
+Louison Parant : **Louison.Parant@etu.uca.fr** +![](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/rainbow.png) + +## ✨ Contributors + + + + + + + + + + + + + + \ No newline at end of file