fit track

Fit-Track

Fit-Track ist eine Übungsprotokoll-Tracking-Anwendung, die mit dem Stapel von Mern (MongoDB, Express, React+Vite, Node.js) erstellt wurde. Diese Dokumentation führt Sie durch den Prozess des Beitrags zu diesem Projekt.

Inhaltsverzeichnis

• Installation
  • Frontend
  • Backend
• Beitragen
  • Gabel des Repositorys
  • Klonen des Repositorys
  • Erstellen eines Zweigs
  • Änderungen vornehmen
  • Änderungen begehen
  • Änderungen drücken
  • Erstellen einer Pull -Anfrage
• Lizenz

Installation

Frontend

1. Navigieren Sie zum frontend -Verzeichnis:

    cd frontend

2. Installieren Sie die Abhängigkeiten:

   npm install

3. Starten Sie den Entwicklungsserver:

   npm run dev

Backend

1. Navigieren Sie zum backend -Verzeichnis:

    cd backend

2. Installieren Sie die Abhängigkeiten:

   npm install

3. Setup MongoDB Atlas:

   1. Gehen Sie zu MongoDB Atlas und erstellen Sie ein Konto, wenn Sie noch keinen haben.
   2. Erstellen Sie einen neuen Cluster, indem Sie den Eingabeaufforderungen folgen. Mongo Atlas Cluster Creation Tutorial
   3. Sobald der Cluster erstellt wurde, gehen Sie zum Abschnitt "Datenbankzugriff" und erstellen Sie einen Benutzer mit den erforderlichen Berechtigungen.
   4. Gehen Sie zum Netzwerkzugriff und ermöglichen Sie Ihre IP -Adresse (oder ermöglichen Sie den Zugriff von überall, wenn Sie lokal testen).
   5. Klicken Sie im Abschnitt Cluster auf Verbindung und wählen Sie dann Ihre Anwendung an . Sie werden eine Verbindungszeichenfolge sehen, die so aussieht:

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

   6. Ersetzen Sie <username> und <password> durch Ihren tatsächlichen MongoDB Atlas Benutzernamen und Ihr Passwort. Kopieren Sie die gesamte Verbindungszeichenfolge.

4. Fügen Sie MongoDB Atlas_uri zur .env -Datei hinzu:

   • Erstellen Sie eine .env -Datei im backend -Verzeichnis.
   • Fügen Sie der .env Datei die folgende Zeile hinzu und ersetzen Sie <your-mongodb-connection-string> durch die Verbindungszeichenfolge, die Sie von MongoDB Atlas kopiert haben:

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

5. Starten Sie den Server:

   node server.js

   oder wenn nodemon für Live -Updates von Backend installiert ist:

   nodemon server.js

Projektstruktur

Frontend

Das frontend -Verzeichnis enthält die React -Anwendung.

• public : Enthält die öffentlichen Vermögenswerte des Antrags.
• src : Enthält den Quellcode der Anwendung.
  • components : Wiederverwendbare UI -Komponenten.
    • Home : Homepage -Komponenten
      • Exercise : Übungsreihenkomponente, um Dauer, Status, DayCheck anzuzeigen
      • ExercisesList : Zeigen Sie die Liste der von dem Benutzer durchgeführten Übungen an
      • HeatMap : Angetrieben von apexcharts.js, um die Routine für die Benutzerübung anzuzeigen
      • Quotes : Aus API -Ninjas und zeigen Sie die Zitate zufällig an, um den Benutzer zu motivieren
      • TotalDays : Um die Anzahl der Tage anzuzeigen, die der Benutzer trainierte
      • UserExperience : Die Benutzererfahrung mit Gamified Experience anzeigen
      • UserRoutine : Zeigen Sie die wöchentliche Routine des Benutzers wie einen Streifen an
    • HomePage : Homepage Anzeigen und Rendering
    • Login : Anzeige einer Anmeldeseite
    • SignUp : Anzeigen einer Anmeldung und Bearbeiten von Benutzerseite
    • navbar : NAVAH -Komponente
• App.jsx : Die Hauptkomponente, die Routen einrichtet.
• main.jsx : Der Einstiegspunkt der React -Anwendung.

Backend

Das backend -Verzeichnis enthält den Node.js -Server und die Express -Anwendung.

• models : Enthält die Mongoose -Schemata.
  • exercise.model : Übungsschema
  • user.model : Benutzerschema
• routes : Enthält die API -Routen.
  • exercises : Backend -API -Routen für Übungen
  • user : Backend -API -Routen für Benutzer
• server.js : Der Einstiegspunkt der Serveranwendung.

Beitragen

Wir begrüßen Beiträge! Befolgen Sie die folgenden Schritte, um zu Fit-Track beizutragen:

Gabel des Repositorys

1. Geben Sie das Repository auf die Schaltfläche "Fork" oben rechts auf der Repository -Seite auf GitHub.

Klonen des Repositorys

2. Klonen Sie Ihr Gabel -Repository in Ihre lokale Maschine:

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

3. Navigieren Sie zum Projektverzeichnis:

    cd Fit-Track

Erstellen eines Zweigs

4. Erstellen Sie eine neue Filiale für Ihre Funktion oder Ihre Fehlerbehebung (erstellen Sie eine Zweigstelle gemäß dem Problem, an dem wir arbeiten):

   git switch -c your-branch-name

Änderungen vornehmen

5. Nehmen Sie Ihre Änderungen an der Codebasis vor. Sie können die Dateien mit Ihrem bevorzugten Code -Editor bearbeiten.

Änderungen begehen

6. Fügen Sie die Änderungen in den Staging -Bereich hinzu:

   git add .

7. Beachten Sie die Änderungen mit einer beschreibenden Nachricht:

   git commit -m " Description of your changes "

Änderungen drücken

8. Drücken Sie die Änderungen in Ihr Gabel -Repository:

   git push origin your-branch-name

Erstellen einer Pull -Anfrage

9. Erstellen Sie eine Pull -Anfrage aus Ihrem Gabel -Repository im Hauptrepository. Gehen Sie auf der Registerkarte "Pull -Anforderungen" im Hauptrepository und klicken Sie auf "Neue Pull Request". Befolgen Sie die Anweisungen, um Ihre Pull -Anfrage zu erstellen.

Dies ist nur der Anfang! Ich freue mich darauf, sinnvollere Beiträge zu leisten und mit dieser erstaunlichen Gemeinschaft zusammenzuarbeiten. Lassen Sie uns zusammen etwas Großartiges bauen und Fit-Track so gut wie möglich sein! ❤️?

Lizenz

Dieses Projekt ist unter der MIT -Lizenz lizenziert - Einzelheiten finden Sie in der Lizenzdatei.