diff --git a/Documentation/Diagrammes/Bowl'in MLD.png b/Documentation/Diagrammes/Bowl'in MLD.png new file mode 100644 index 0000000..f19d3ea Binary files /dev/null and b/Documentation/Diagrammes/Bowl'in MLD.png differ diff --git a/Documentation/Diagrammes/Bowlin - Diagramme de séquence.png b/Documentation/Diagrammes/Bowlin - Diagramme de séquence.png new file mode 100644 index 0000000..9f96516 Binary files /dev/null and b/Documentation/Diagrammes/Bowlin - Diagramme de séquence.png differ diff --git a/Documentation/Diagrammes/BowlinClasses.png b/Documentation/Diagrammes/BowlinClasses.png new file mode 100644 index 0000000..c09769b Binary files /dev/null and b/Documentation/Diagrammes/BowlinClasses.png differ diff --git a/Documentation/Images/Analysis-Page.png b/Documentation/Images/Analysis-Page.png new file mode 100644 index 0000000..a390ca6 Binary files /dev/null and b/Documentation/Images/Analysis-Page.png differ diff --git a/Documentation/Images/Home-Page.png b/Documentation/Images/Home-Page.png new file mode 100644 index 0000000..1716d6a Binary files /dev/null and b/Documentation/Images/Home-Page.png differ diff --git a/Documentation/Images/HowToClone.gif b/Documentation/Images/HowToClone.gif new file mode 100644 index 0000000..aba03cb Binary files /dev/null and b/Documentation/Images/HowToClone.gif differ diff --git a/Documentation/Images/HowToLaunch.png b/Documentation/Images/HowToLaunch.png new file mode 100644 index 0000000..c209d5c Binary files /dev/null and b/Documentation/Images/HowToLaunch.png differ diff --git a/Documentation/Images/Profile-Page.png b/Documentation/Images/Profile-Page.png new file mode 100644 index 0000000..e4ece89 Binary files /dev/null and b/Documentation/Images/Profile-Page.png differ diff --git a/Documentation/Images/Ranking-Page.png b/Documentation/Images/Ranking-Page.png new file mode 100644 index 0000000..2cff3ed Binary files /dev/null and b/Documentation/Images/Ranking-Page.png differ diff --git a/README.md b/README.md index 780372a..e8479a2 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,8 @@
+[Présentation](#présentation) | [Répartion](#répartition-du-gitlab) | [Fonctionnement](#fonctionnement-📑) | [Deploiement](#deploiement-🚀) | [Techniciens](#technicien-en-charge-de-l'application) | [Remerciements](#remerciements-👋) | [Wiki](https://codefirst.iut.uca.fr/git/BowlDev/Bowl_in/wiki) + ---   ![Dart](https://img.shields.io/badge/Dart-000?style=for-the-badge&logo=dart&logoColor=blue&color=white) @@ -23,9 +25,7 @@
-## Deploiement -- [x]   ![IOS](https://img.shields.io/badge/IOS-000?style=for-the-badge&logo=apple&logoColor=black&color=white) -- [x]   ![Android](https://img.shields.io/badge/Android-000?style=for-the-badge&logo=android&logoColor=white&color=green) +## Présentation **Nom de l'application** : Bowl'in :bowling: @@ -50,6 +50,71 @@ La racine de notre gitlab est composé de deux dossier essentielles au projet: :warning: Code de l'application en cours! + +## Fonctionnement 📑 + +- Comment récuperer le projet ? + +Tout d'abord, si ce n'est pas déjà fait, clonez le dépôt de la branche **master/main**. Pour cela, copiez l'URL du dépôt Git : + +
+ +![Comment cloner](Documentation/Images/HowToClone.gif) + +
+ +En utilisant ce lien, vous pouvez cloner le dépôt dans un terminal ou via Tortoise, mais si vous ne savez pas comment faire, vous devez d'abord installer Git for Windows en suivant ce [lien](https://gitforwindows.org/), puis suivre le [tutoriel](https://docs.github.com/fr/repositories/creating-and-managing-repositories/cloning-a-repository)) + +:information_source: *Si vous n'êtes pas familier avec Git, vous pouvez également récupérer le dépôt au format zip en cliquant simplement avec le bouton droit de la souris.* + + +:warning: Maintenant, vient l'étape un peu plus complexe : **Android Studio** ! +Avant de pouvoir exécuter l'application, vous devez installer le SDK de Flutter et l'IDE Android Studio. Tout d'abord, rendez-vous sur le site de [Flutter](https://docs.flutter.dev/get-started/install/windows) qui explique en détail comment procéder :heavy_exclamation_mark: + +Pour *Android Studio*, vous n'avez qu'à installer l'application en suivant ce [lien](https://developer.android.com/studio) et en suivant les étapes ! + +Une fois *Android Studio* installer, il ne vous reste seulement à ouvrir le projet récuperer dans ce dépôt que avez du récuperer au préalable : + +
+ +![Comment ouvrir le projet](Documentation/Images/HowToLaunch.png) + +
+ +Il ne vous reste plus qu'à connecter votre téléphone **Android** (n'oubliez pas d'activer le mode développeur et le débogage USB) ou à utiliser un **émulateur** (je vous invite à regarder une vidéo qui vous explique comment faire si vous ne savez pas) qui est également une option valable, mais il prend beaucoup de place en mémoire :cd: + +:information_source: *N'oubliez pas de configurer le lancement de l'application en sélectionnant le fichier [main.dart](Sources/bowlin_project/lib/main.dart)* + +- Comment utiliser l'application ? + +L'application à été réaliser à un très simple pour n'importe quel utilisateur et se résume en 4 grande 4 pages : + +
+ + + + + + +
+ +:confounded: Pas de panique, ce n'est pas si compliqué que ça ! + +Pour la première page, qui est la page **Home** de l'application, nous pouvons lancer des parties ou rejoindre celles de nos amis. Ces parties sont alors répertoriées du plus récent au plus ancien. + +La page **Ranking** quant à elle permet d'obtenir un classement entre amis et de savoir quelle personne a obtenu le meilleur score. + +Dois-je vraiment expliquer la page d'**analyse** ? Elle permet, comme n'importe quelle page, d'afficher des statistiques sur l'ensemble de vos parties, que ce soit votre ratio de victoires, de spares, etc. + +Enfin, la dernière et non des moindres, la page **profil** qui regroupe les informations de votre compte, telles que votre meilleur score, votre dernière connexion... mais aussi les *succès* (plus communément appelés "achievements") que vous avez obtenus au cours de vos parties. + +``` Amusez-vous bien !``` + +## Deploiement 🚀 +- [x]   ![IOS](https://img.shields.io/badge/IOS-000?style=for-the-badge&logo=apple&logoColor=black&color=white) +- [x]   ![Android](https://img.shields.io/badge/Android-000?style=for-the-badge&logo=android&logoColor=white&color=green) + + ## Technicien en charge de l'application - Emre KARTAL : emre.kartal@etu.uca.fr @@ -58,6 +123,10 @@ La racine de notre gitlab est composé de deux dossier essentielles au projet: - David D'ALMEIDA : david.d_almeida@etu.uca.fr - Louison PARANT : louison.parant@etu.uca.fr +## Remerciements 👋 + +:information_source: Un remerciement chaleureux est adressé à tous ceux qui ont participé à la réalisation du projet, en particulier à M. Chevaldonné et Mme Chatti pour leur aide précieuse. +
© PM2
\ No newline at end of file