/duckLift

Primary LanguageTypeScriptMIT LicenseMIT


Logo

DuckLift : Application de Club d'Haltérophilie

Une application pour optimiser le suivi et la gestion de l'entraînement en haltérophilie.

Pour plus de détails, vous pouvez
Explorer la documentation »

Voir la Démonstration · Signaler un Bug · Demander une Fonctionnalité


Table des Matières
  1. A propos du projet
  2. Fonctionnalités
  3. Technologies Utilisées
  4. Contribuer
  5. Licence
  6. Contact

À propos du Projet

DuckLift est une application web et mobile conçue pour optimiser le suivi et la gestion de l'entraînement en haltérophilie. Ce projet vise à fournir une solution intuitive pour les athlètes et entraîneurs, tout en consolidant mes compétences en développement logiciel.

(retour en haut)


Fonctionnalités

  • Journal d'Entraînement Personnalisé : Les athlètes peuvent visualiser la programmation quotidienne avec des détails sur les exercices, les pourcentages de travail et les répétitions.
  • Profil Athlète : Les utilisateurs créent et mettent à jour leur profil, y compris les informations de base et les statistiques de performance telles que le poids et la taille.
  • Gestion des Performances : Une page dédiée permet aux athlètes de saisir et de visualiser leurs maxima, avec un calculateur de charges pour personnaliser les programmes.
  • Tableau de Bord Coach : Les coachs ont accès à une interface de gestion pour accéder aux profils des athlètes, créer et publier des entraînements, et gérer une bibliothèque d'exercices.
  • Notifications et Annonces : Un système de notifications informe les utilisateurs des mises à jour importantes, avec des annonces et des messages de la part des coachs.
  • Réglages et Support : Les utilisateurs peuvent accéder aux réglages de l'application, y compris la gestion du compte, le changement de mot de passe, la FAQ et l'aide.

Fonctionnalités à Venir

  • Mode Hors Ligne : Permettant l'accès aux fonctionnalités essentielles même sans connexion internet.
  • Suivi de la Progression : Des graphiques et des visualisations pour un suivi détaillé des progrès.
  • Chat du Club : Une fonctionnalité de messagerie pour faciliter la communication entre les membres du club.
  • Personnalisation de l'Interface : Introduction d'un mode clair/sombre et options de choix de langue.

(retour en haut)


Technologies Utilisées

  • Front-End : React Native, React, React Router, TypeScript, Expo, Chakra UI, TanStack Query.
  • Back-End : .NET, Entity Framework Core, LINQ, Duende Identity Server.
  • Base de Données : PostgreSQL.
  • CI/CD : Docker, Docker Compose, GitHub Actions (Ou Jenkins).
  • Gestion de projet : Notion
  • Qualité du Code : Eslint, Prettier, SonarQube.

(retour en haut)


Contribuer

Voici un guide étape par étape pour contribuer :

  1. Prérequis

Avant de commencer, assurez-vous d'avoir installé les logiciels suivants sur votre machine :

Git: Nécessaire pour cloner le dépôt et gérer les versions. Télécharger Git. Docker : A venir Autres : A vernir

  1. Fork du Projet

Créez une copie du projet sur votre compte GitHub. Cela vous permet d'apporter des modifications sans affecter le projet original.

  1. Visitez le repository GitHub de DuckLift.

  2. Cliquez sur le bouton Fork en haut à droite de la page.

  3. Cloner le Fork

Après avoir forké le projet, clonez-le sur votre machine locale pour commencer à travailler dessus.

git clone https://github.com/Netsbump/DuckLift.git
cd DuckLift
  1. Configurer un Upstream Remote

Pour garder votre fork à jour avec le projet original, configurez un remote "upstream" pointant vers le dépôt d'origine.

git remote add upstream https://github.com/Netsbump/DuckLift.git
  1. Créer une Branche de Fonctionnalité

Pour chaque nouvelle fonctionnalité ou correction, créez une nouvelle branche. Cela facilite le suivi des changements et la gestion des pull requests.

git checkout -b feature/NomDeVotreFonctionnalité
  1. Faire des Changements

Apportez vos modifications ou ajouts au code. Assurez-vous de respecter les conventions de codage et les bonnes pratiques du projet.

  1. Garder Votre Branche à Jour

Avant de pousser vos changements, assurez-vous que votre branche est à jour avec la branche principale du projet original.

git fetch upstream
git rebase upstream/main
  1. Committez vos Changements

Faites des commits clairs et significatifs. Chaque commit doit idéalement représenter une unité logique de changement.

Chaque commit doit idéalement représenter une unité logique de changement. Voici quelques bonnes pratiques pour les messages de commit :

  • Commencez le message par un type de changement comme feat, fix, docs, style, refactor, test, ou chore.
  • Utilisez le format type: sujet pour vos messages.
  • Le sujet ne doit pas dépasser 50 caractères.
  • Utilisez l'impératif présent, par exemple : "Ajoute" plutôt que "Ajouté".
git add .
git commit -m "feat: Ajoute une fonction de recherche avancée"
  1. Push Vers Votre Fork

Poussez les changements de votre branche vers votre fork sur GitHub.

git push origin feature/NomDeVotreFonctionnalité
  1. Ouvrir une Pull Request
  • Retournez sur le repository GitHub de DuckLift.
  • Vous verrez un bouton Compare & pull request. Cliquez dessus.
  • Remplissez une description claire et détaillée de vos changements.
  • Soumettez la pull request.
  1. Bonnes Pratiques
  • Code propre et lisible : Assurez-vous que votre code est bien formaté et suit les conventions du projet.
  • Tests : Ajoutez des tests pour les nouvelles fonctionnalités ou les corrections de bugs.
  • Documentation : Mettez à jour le README et tout autre document nécessaire pour refléter vos changements.

(retour en haut)


Licence

Distribué sous la Licence MIT. Voir le fichier LICENSE pour plus d'informations.

(retour en haut)


Contact

Twitter - [@votre_twitter] - email@example.com Linkedin

(retour en haut)