From 5286bdabfb3c968083019cdaefd2bd856361b55b Mon Sep 17 00:00:00 2001 From: anperederi Date: Fri, 24 Nov 2023 23:05:08 +0100 Subject: [PATCH] :memo: add LICENSE.md and update README.md --- LICENSE.md | 21 +++++++ README.md | 159 +++++++++++++++++++++++++++-------------------------- 2 files changed, 103 insertions(+), 77 deletions(-) create mode 100644 LICENSE.md diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 00000000..7f497918 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2023 antoine.perederii + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md index 7e1db97d..757289c8 100755 --- a/README.md +++ b/README.md @@ -1,26 +1,34 @@
+

HeartTrack

+ + +
-[Présentation](#présentation) | [Répartion](#répartition-du-git) | [Développement](#développement) | [Wiki](https://codefirst.iut.uca.fr/git/HeartTrack_Dev/Web/wiki) ---- +---   ![PHP](https://img.shields.io/badge/PHP-000?style=for-the-badge&logo=Php&logoColor=white&color=purple)   ![CSS](https://img.shields.io/badge/CSS-000?style=for-the-badge&logo=css3&logoColor=white&color=darkblue)   ![DOCKER](https://img.shields.io/badge/Docker-2496ED.svg?style=for-the-badge&logo=Docker&logoColor=white)   ![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) -
+
+ ---- - -
+ + +# 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) -# HeartTrack ## Présentation @@ -29,20 +37,20 @@ ### Contexte -HeartTrack est une application web PHP et mobile Android destinée aux sportifs pour l'analyse de courbes cardiaques. L'objectif principal de cette application est de récupérer les données de fréquence cardiaque à partir d'une montre, de les afficher sous forme de courbes, d'identifier des patterns, de fournir des statistiques et de réaliser des prédictions liées à l'effort physique, à la chaleur, à la récupération, etc. +HeartTrack est une application web PHP et mobile Android destinée aux sportifs et aux coachs afin de permettre l'analyse de courbes cardiaques et le suivie d'équipe sportives. 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 patterns, 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 complète pour l'analyse des données de fréquence cardiaque, en mettant l'accent sur les besoins des sportifs. 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é. +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**](Sources) : **Code de l'application** +[**Sources**](Sources/README_SOURCES.md) : **Code de l'application** -[**Documents**](Documents) : **Documentation de l'application** +[**Documents**](Documents/README_DOCUMENTS.md) : **Documentation de l'application** --- +--- 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 : @@ -50,70 +58,67 @@ Le projet HeartTrack utilise un modèle de flux de travail Git (Gitflow) pour or - **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 déployer une version démo de l'application. Elle est mise à jour avec les dernières fonctionnalités et surtout la totalité de leurs test en développement. +- **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. - - -## Développement - -### Travailler sur une Issue - -Si vous êtes amené à travailler sur une issue, suivez ces principes : - -1. Les issues sont créées dans le système de gestion de versions (Git), chaque issue ayant un numéro unique. - -2. Lorsque vous décidez de travailler sur une issue, attribuez-vous l'issue et créez une branche avec un nom correspondant à l'issue sous la forme suivante : "issue_#32_nom" où 32 est le numéro de l'issue et nom est son libellé. - -3. Une fois que vous avez résolu l'issue dans votre branche, assurez-vous de mettre à jour le changelog avec les modifications apportées. - -4. Ensuite, poussez votre branche sur le référentiel distant et créez une merge request pour que vos modifications soient examinées par les autres membres de l'équipe. - -## Prérequis - -Avant de commencer à travailler sur le projet HeartTrack, assurez-vous d'avoir les prérequis suivants installés : - -- Serveur web (par exemple, Apache) -- PHP (version recommandée) -- Base de données (par exemple, MySQL) -- Git - -## Installation - -Pour installer et exécuter le projet HeartTrack, suivez ces étapes : - -1. Clonez ce référentiel sur votre machine locale en utilisant la commande suivante : - `git clone https://codefirst.iut.uca.fr/git/FitDev/Projet_fit_web` - -2. Configurez votre environnement de développement avec les prérequis mentionnés ci-dessus. - -3. Copiez le fichier de configuration d'exemple et configurez les paramètres de l'application : - -cp config/config.example.php config/config.php -[pas encore la pour l'instant] -4. Importez la structure de la base de données à partir du fichier SQL fourni : - -mysql -u votre_nom_utilisateur -p < db_schema.sql ou psql comme vous le souhaitez - - -5. Démarrez votre serveur web et accédez à l'application via le navigateur. - -`npm run dev` -ou -`composer dev` e.q `php composer.phar dev` - -## Exécution - -Pour exécuter l'application, suivez les instructions d'installation ci-dessus. Une fois l'application configurée et le serveur web en cours d'exécution, accédez à l'application via votre navigateur web. - -## Déploiement en Démo - -Pour déployer une version de démonstration de l'application, utilisez la branche "demo" du référentiel. Cette branche est généralement mise à jour avec les dernières fonctionnalités en développement. - -## Déploiement en Production - -Pour déployer la version de production de l'application, utilisez la branche "prod" du référentiel. - ---- - -N'hésitez pas à contribuer au développement de HeartTrack en résolvant des issues ou en ajoutant de nouvelles fonctionnalités. Nous vous encourageons à suivre les principes et les pratiques décrites dans ce document pour un développement efficace et collaboratif. \ No newline at end of file +- **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](https://code.visualstudio.com/) - Free IDE +* [Git](https://git-scm.com/) - Versioning +* [XAMPP : X, Apache, MySQL, Perl, PHP](https://www.apachefriends.org/fr/index.html) - Languages + +## Getting Started +1. Cloner le répos +2. Faire un `composer install` dans le dossier `Sources/` +3. Importer la base de données `Sources/Database/hearttrack.sql` +4. Lancer le serveur Apache et MySQL +5. Lancer le projet avec `php -S localhost:8000 -t Sources/` +6. Ouvrir le navigateur et aller sur `localhost:8000/index.php` + +## Features +* [x] Création de la base de données +* [ ] Création des tables +* [ ] Création des requêtes +* [ ] Création des vues + +## Ce que nous avons fait +* [x] Création de la base de données +* [ ] Création des tables +* [ ] Création des requêtes +* [ ] Création des vues + +## Fabriqué avec +* [JetBrains Toolbox](https://www.jetbrains.com/fr-fr/toolbox-app/) - IDE +* [CodeFirst](https://codefirst.iut.uca.fr/) - Gitea + * [Drone](https://codefirst.iut.uca.fr/) - CI + * [SonarQube](https://codefirst.iut.uca.fr/sonar/) - Qualité +* [PHP 8](https://www.php.net/downloads) - Langage + * [html 5, CSS 3](https://developer.mozilla.org/fr/docs/Web/HTML) - Langage + * [Twig](https://twig.symfony.com/) - Langage +* [Doxygen](https://codefirst.iut.uca.fr/sonar/) - Documentation + + +## Contributeurs +* [Antoine PEREDERII](https://codefirst.iut.uca.fr/git/antoine.perederii) +* [Paul LEVRAULT](https://codefirst.iut.uca.fr/git/paul.levrault) +* [Kevin MONTEIRO](https://codefirst.iut.uca.fr/git/kevin.monteiro) +* [Antoine PINAGOT](https://codefirst.iut.uca.fr/git/antoine.pinagot) +* [David D'HALMEIDA](https://codefirst.iut.uca.fr/git/david.d_almeida) + +## Comment contribuer +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`) +5. Créez une nouvelle Pull Request + + +## License +Ce projet est sous licence ``MIT`` - voir le fichier [LICENSE.md](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. \ No newline at end of file