fit track

Track fit

Fit-Track est une application de suivi du journal d'exercice construit à l'aide de la pile Mern (MongoDB, Express, React + Vite, Node.js). Cette documentation vous guidera tout au long du processus de contribution à ce projet.

Table des matières

• Installation
  • L'extrémité avant
  • Backend
• Contributif
  • Faire le référentiel
  • Cloner le référentiel
  • Créer une branche
  • Apporter des changements
  • Commettre des changements
  • Pousser les changements
  • Créer une demande de traction
• Licence

Installation

L'extrémité avant

1. Accédez au répertoire frontend :

    cd frontend

2. Installez les dépendances:

   npm install

3. Démarrer le serveur de développement:

   npm run dev

Backend

1. Accédez au répertoire backend :

    cd backend

2. Installez les dépendances:

   npm install

3. Configuration MongoDB Atlas:

   1. Allez à MongoDB Atlas et créez un compte si vous n'en avez pas déjà.
   2. Créez un nouveau cluster en suivant les invites. Tutoriel de création de grappes de Mongo Atlas
   3. Une fois le cluster créé, accédez à la section d'accès à la base de données et créez un utilisateur avec les privilèges nécessaires.
   4. Accédez à l'accès au réseau et autorisez votre adresse IP (ou autorisez l'accès à partir de n'importe où si vous testez localement).
   5. Dans la section Clusters , cliquez sur Connectez , puis choisissez Connectez votre application . Vous verrez une chaîne de connexion qui ressemble à ceci:

       mongodb+srv://<username>:<password>@cluster0.mongodb.net/?retryWrites=true&w=majority
      

   6. Remplacez <username> et <password> par votre nom d'utilisateur et votre mot de passe MongoDB réels. Copiez la chaîne de connexion entière.

4. Ajoutez MongoDB Atlas_uri au fichier .env :

   • Créez un fichier .env dans le répertoire backend .
   • Ajoutez la ligne suivante dans le fichier .env , en remplaçant <your-mongodb-connection-string> -String> par la chaîne de connexion que vous avez copiée à partir de MongoDB Atlas:

     ATLAS_URI=mongodb+srv:// < username > : < password > @cluster0.mongodb.net/fit-track ? retryWrites=true & w=majority

5. Démarrez le serveur:

   node server.js

   ou si nodemon est installé pour les mises à jour en direct du backend:

   nodemon server.js

Structure du projet

L'extrémité avant

Le répertoire frontend contient l'application React.

• public : contient les actifs publics de la demande.
• src : contient le code source de l'application.
  • components : composants d'interface utilisateur réutilisables.
    • Home : Composants de page d'accueil
      • Exercise : composant de ligne d'exercice pour afficher la durée, le statut, le jour de jour
      • ExercisesList : Pour afficher la liste des exercices effectués par l'utilisateur
      • HeatMap : alimenté par ApexCharts.js pour afficher la routine d'exercice de l'utilisateur
      • Quotes : de l'API ninjas et affichez les citations au hasard pour motiver l'utilisateur
      • TotalDays : pour afficher le nombre de jours, l'utilisateur a exercé
      • UserExperience : Pour afficher l'expérience utilisateur de l'expérience gamifiée
      • UserRoutine : Pour afficher la routine hebdomadaire de l'utilisateur comme une séquence
    • HomePage : affichage et rendu page d'accueil
    • Login : affichage d'une page de connexion
    • SignUp : affichage d'une page d'inscription et modifier
    • navbar : composant Navbar
• App.jsx : le composant principal qui configure les routes.
• main.jsx : le point d'entrée de l'application React.

Backend

Le répertoire backend contient le serveur Node.js et l'application Express.

• models : contient les schémas de la mongoose.
  • exercise.model : schéma d'exercice
  • user.model : schéma utilisateur
• routes : contient les routes API.
  • exercises : routes API backend pour les exercices
  • user : routes API backend pour les utilisateurs
• server.js : le point d'entrée de l'application du serveur.

Contributif

Nous accueillons les contributions! Pour contribuer à la track fit, suivez ces étapes:

Faire le référentiel

1. Fourk le référentiel en cliquant sur le bouton "Fork" en haut à droite de la page du référentiel sur GitHub.

Cloner le référentiel

2. Clone votre référentiel à fourche vers votre machine locale:

   git clone https://github.com/your-username/Fit-Track.git

3. Accédez au répertoire du projet:

    cd Fit-Track

Créer une branche

4. Créez une nouvelle branche pour votre fonctionnalité ou votre correction de bogue (créez une branche en fonction du problème qui fonctionne):

   git switch -c your-branch-name

Apporter des changements

5. Apportez vos modifications à la base de code. Vous pouvez modifier les fichiers à l'aide de votre éditeur de code préféré.

Commettre des changements

6. Ajouter les modifications à la zone de mise en scène:

   git add .

7. Commettre les modifications avec un message descriptif:

   git commit -m " Description of your changes "

Pousser les changements

8. Poussez les modifications à votre référentiel fourchu:

   git push origin your-branch-name

Créer une demande de traction

9. Créez une demande de traction de votre référentiel à fourche vers le référentiel principal. Accédez à l'onglet "Pull Demandes" dans le référentiel principal, puis cliquez sur "Nouvelle demande de pull". Suivez les instructions pour créer votre demande de traction.

Ce n'est que le début! J'ai hâte de faire des contributions plus significatives et de collaborer avec cette communauté incroyable. Construisons quelque chose de super ensemble et faisons de la track en ajustement le meilleur possible! ❤️?

Licence

Ce projet est autorisé en vertu de la licence MIT - voir le fichier de licence pour plus de détails.