Antoine PEREDERII
ceb993528e
|
11 months ago | |
---|---|---|
Documents | 11 months ago | |
Sources | 11 months ago | |
.drone.yml | 11 months ago | |
.gitignore | 11 months ago | |
LICENSE.md | 1 year ago | |
README.md | 1 year ago | |
notifymail.sh | 1 year ago |
README.md
HeartTrack
Table des matières
Présentation | Répartition du Git | Documentation | Prerequisites | Getting Started | Features | Ce que nous avons fait | Fabriqué avec | Contributeurs | Comment contribuer | License | Remerciements
Présentation
Nom de l'application : HeartTrack
Contexte
HeartTrack est une application web PHP et mobile Android destinée aux sportifs et aux coachs afin de permettre l'analyse de courbes de fréquences cardiaques et le suivi d'équipe sportive. L'objectif principal de cette application est de récupérer les données de fréquence cardiaque à partir de fichiers .FIT, de les afficher sous forme de courbes, d'identifier des paternes, de fournir des statistiques et de réaliser des prédictions liées à l'effort physique, à la chaleur, à la récupération, etc.
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é.
Répartition du Git
Sources : Code de l'application
Documents : Documentation de l'application et diagrammes
Wiki : Wiki de notre projet (attendus PHP)
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 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 test : Cette branche est utilisée pour permettre différents tests sur l'application.
-
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.
Documentation
Documentation et informations à propos de HearthTrack
disponible ici
Prerequisites
- Visual Studio code - exemple d'IDE gratuit
- Git - Versioning
- XAMPP : X, Apache, MySQL, Perl, PHP - Langages
Getting Started
- Cloner le répos
- Faire un
composer install
dans le dossierSources/
- Importer la base de données
Sources/Database/hearttrack.sql
- Lancer le serveur Apache et MySQL
- Lancer le projet avec
php -S localhost:8000 -t Sources/
- Ouvrir le navigateur et aller sur
localhost:8000/index.php
Features
- Import de fichier .fit
- Ajout d'amis
- Création de compte
- Ajout d'athlete pour le coach
- Création d'entrainement
- Création de courbes
- Gérer ses permissions
Ce que nous avons fait
- PDO et Pattern Gateway
- implémentation MVC et 2 contrôleurs
- pattern Frontcontroleur sans routage
- autoloader simple sans namespace ?
- validation des entrées
- vues dont vue erreur
- partie administration ou équivalent
- vues complètes bien segmentées et utilisation bootstrap
- utilisation namespace et psr4
- moteur twig pour les vues
- pattern Frontcontroleur avec routage
- Javascript
- pattern fabrique
Fabriqué avec
- JetBrains Toolbox - IDE
- CodeFirst - Gitea
- PHP 8 - Langage
- html 5, CSS 3 - Langage
- Twig - Langage
- Doxygen - Documentation
Contributeurs
Comment contribuer
- Forkez le projet (https://codefirst.iut.uca.fr/git/HeartDev/Web)
- Créez votre branche (
git checkout -b feature/featureName
) - commit vos changements (
git commit -am 'Add some feature'
) - Push sur la branche (
git push origin feature/featureName
) - Créez une nouvelle Pull Request
License
Ce projet est sous licence MIT
- voir le fichier LICENSE.md pour plus d'informations.
Remerciements
Ce projet a été réalisé dans le cadre de la SAÉ Projet Web et Mobile de l'IUT de Clermont-Ferrand.