From 1ba710d521788d4245bd7ce98c6bac8a8a6d8184 Mon Sep 17 00:00:00 2001 From: anperederi Date: Tue, 16 Jan 2024 11:28:31 +0100 Subject: [PATCH] update readme --- README.md | 74 +++++++++++++----- .../HeartTrack.csproj.GenerateResource.cache | Bin 692 -> 692 bytes 2 files changed, 54 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index b0549bd..830b7b5 100755 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@
-

HeartTrack

+

HeartTrack - Admin

@@ -9,17 +9,15 @@ --- -  ![PHP](https://img.shields.io/badge/Blazor-56478C?style=for-the-badge&logo=Blazor&logoColor=FFFFFF&labelColor=56478C) +  ![Blazor](https://img.shields.io/badge/Blazor-56478C?style=for-the-badge&logo=Blazor&logoColor=FFFFFF&labelColor=56478C)   ![CSS](https://img.shields.io/badge/CSS-000?style=for-the-badge&logo=css3&logoColor=white&color=darkblue) -  ![DOCKER](https://img.shields.io/badge/.NET-56478C?style=for-the-badge&logo=.NET&logoColor=FFFFFF&labelColor=56478C) -  ![PostgreSQL](https://img.shields.io/badge/Postgresql-000?style=for-the-badge&logo=postgresql&logoColor=white&color=blue) -  ![JAVASCRIPT](https://img.shields.io/badge/JavaScript-000?style=for-the-badge&logo=javascript&logoColor=white&color=yellow) +  ![.NET](https://img.shields.io/badge/.NET-56478C?style=for-the-badge&logo=.NET&logoColor=FFFFFF&labelColor=56478C)
# Table des matières -[Présentation](#présentation) | [Répartition du Git](#répartition-du-git) | [Documentation](#documentation) | [Prerequisites](#prerequisites) | [Getting Started](#getting-started) | [Features](#features) | [Ce que nous avons fait](#ce-que-nous-avons-fait) | [Fabriqué avec](#fabriqué-avec) | [Contributeurs](#contributeurs) | [Comment contribuer](#comment-contribuer) | [License](#license) | [Remerciements](#remerciements) +[Présentation](#présentation) | [Fonctionnalités principales](#fonctionnalités-principales) | [Répartition du Git](#répartition-du-git) | [Prerequis](#prérequis) | [Fabriqué avec](#fabriqué-avec) | [Contributeurs](#contributeurs) | [Comment contribuer](#comment-contribuer) | [License](#license) | [Remerciements](#remerciements) @@ -33,7 +31,17 @@ HeartTrack est une application web PHP et mobile Android destinée aux sportifs ### Récapitulatif du Projet -Le projet HeartTrack, avec son application HeartTrack, vise à offrir une solution Open Source d'analyse des données de fréquence cardiaque, en mettant l'accent sur les besoins des sportifs et des coachs. L'application sera capable de traiter et d'interpréter les données de manière intelligente, fournissant ainsi des informations précieuses pour optimiser les performances sportives et la santé. +Ce dépôt contient une application Blazor conçue pour faciliter l'administration des utilisateurs au sein de votre application. L'application utilise le framework Blazor, qui permet le développement d'applications web interactives avec .NET. + +## Fonctionnalités principales + +1. **Gestion des Utilisateurs**: Ajoutez, modifiez et supprimez des utilisateurs de manière simple et efficace. + +2. **Rôles Utilisateurs**: Attribuez des rôles à chaque utilisateur pour définir leurs permissions et accès. + +3. **Tableau de Bord Convivial**: Interface utilisateur intuitive pour une expérience d'administration agréable. + +4. **Sécurité Intégrée**: Utilisation des fonctionnalités de sécurité de Blazor pour protéger les données sensibles. ## Répartition du Git @@ -42,28 +50,55 @@ Le projet HeartTrack, avec son application HeartTrack, vise à offrir une soluti [**Documents**](Documents/README_DOCUMENTS.md) : **Documentation de l'application et diagrammes** - - --- Le projet HeartTrack utilise un modèle de flux de travail Git (Gitflow) pour organiser le développement. Voici une brève explication des principales branches : -- **branche prod** : Cette branche contient la version de production stable de l'application. Les modifications sur cette branche sont généralement destinées à des mises en production. +- **branche WORK-NAME** : Cette branche contient la version de travail des différents membres de l'équipe. Les modifications sur cette branche sont bien souvent réalisé par le nom du membre en question. -- **branche master** : La branche master est similaire à la branche de production, mais elle peut contenir des fonctionnalités en cours de développement qui sont presque prêtes pour une mise en production. +- **branche master** : La branche master est similaire à la branche de production, mais elle contient la version stable et final de notre application. -- **branche test** : Cette branche est utilisée pour permettre différents tests sur l'application. +### API PHP -- **branche issue** : Pour chaque problème (issue) que vous résolvez, vous devez créer une branche portant le nom de l'issue, par exemple, "issue_#32_nom" où 32 est le numéro de l'issue et nom est une description courte de l'issue. Une fois l'issue résolue, assurez-vous de mettre à jour le changelog et de créer une merge request. -- **branche démo** : Cette branche est utilisée pour déployer une version démo de l'application. Elle est mise à jour avec les dernières fonctionnalités en développement. +L'application Blazor utilise une API en PHP pour récupérer les données depuis la base de données. +Pour l'utiliser, vous devez faire tourner notre projet PHP disponible [ici](https://codefirst.iut.uca.fr/git/HeartDev/Web/src/branch/API_tests) sur votre machine locale. Pour ensuite changer le type de skockage par `API` dans le fichier `monfichier.cs` dans le dossier `Data` de l'application Blazor. -## Documentation -Documentation et informations à propos de `HearthTrack` disponible [ici]() ### Prérequis -* [Visual Studio Code](https://code.visualstudio.com/) - Exemple d'IDE gratuit +* [Visual Studio](https://visualstudio.microsoft.com/fr/vs/) - IDE * [Git](https://git-scm.com/) - Gestion de version -* [PostgreSQL](https://www.postgresql.org/) - Base de Données +* [.NET SDK](https://dotnet.microsoft.com/download) - Platform open-source pour le développement d'applications + +## Installation et Exécution + +1. Clonez ce dépôt sur votre machine locale : + + ```bash + git clone https://github.com/votre-utilisateur/Blazor-User-Admin.git + ``` + +2. Accédez au répertoire du projet : + + ```bash + cd Blazor-User-Admin + ``` + +3. Lancez l'application avec la commande : + + ```bash + dotnet run + ``` + +4. Ouvrez votre navigateur et accédez à [https://localhost:5001](https://localhost:5001) pour voir l'application en action. + +Pour des raison de manque de la partie php, vous ne pourrez utiliser l'application qu'en localStorage. Il est cependant possible de tester l'aaplication avec la partie API en PHP en faisant tourner en local le projet php disponible [ici](https://codefirst.iut.uca.fr/git/HeartDev/Web/src/branch/API_tests) et en changant le type de stockage dans le fichier `monfichier.cs` dans le dossier `Data` de l'application Blazor. +Comme ceci : +```csharp +public class MonFichier +{ + public static string TypeStockage = "API"; +} +``` ### Fabriqué avec * [Visual Studio](https://visualstudio.microsoft.com/fr/vs/) - IDE @@ -73,7 +108,6 @@ Documentation et informations à propos de `HearthTrack` disponible [ici]() * [Blazor](https://dotnet.microsoft.com/apps/aspnet/web-apps/blazor) - Framework Web * [C#](https://docs.microsoft.com/fr-fr/dotnet/csharp/) - Langage * [HTML 5, CSS 3](https://developer.mozilla.org/fr/docs/Web/HTML) - Langages -* [Doxygen](https://codefirst.iut.uca.fr/sonar/) - Documentation ## Contributeurs * [Antoine PEREDERII](https://codefirst.iut.uca.fr/git/antoine.perederii) @@ -83,7 +117,7 @@ Documentation et informations à propos de `HearthTrack` disponible [ici]() * [David D'HALMEIDA](https://codefirst.iut.uca.fr/git/david.d_almeida) ## Comment contribuer -1. Forkez le projet () +1. Forkez le projet () 2. Créez votre branche (`git checkout -b feature/featureName`) 3. commit vos changements (`git commit -am 'Add some feature'`) 4. Push sur la branche (`git push origin feature/featureName`) diff --git a/Sources/HeartTrack/obj/Debug/net6.0/HeartTrack.csproj.GenerateResource.cache b/Sources/HeartTrack/obj/Debug/net6.0/HeartTrack.csproj.GenerateResource.cache index a77e56d85cf006f62c79f8e4261457ff79386d8a..1f4753c60961d8bfe54d1af6a7b23c005da757cc 100644 GIT binary patch delta 18 ZcmdnOx`lOvD-+wS`qac6vB};{nE*WR1{weW delta 18 ZcmdnOx`lOvD-&CCi{8Dnf|I?OG66o;28sXx