fit track

مسار مناسب

FIT-TRACK هو تطبيق تتبع سجل التمرين تم تصميمه باستخدام مكدس MERN (MongoDB ، Express ، React+Vite ، Node.js). ستوجهك هذه الوثائق خلال عملية المساهمة في هذا المشروع.

جدول المحتويات

• تثبيت
  • الواجهة
  • الخلفية
• المساهمة
  • Forking المستودع
  • استنساخ المستودع
  • إنشاء فرع
  • إجراء تغييرات
  • ارتكاب التغييرات
  • دفع التغييرات
  • إنشاء طلب سحب
• رخصة

تثبيت

الواجهة

1. انتقل إلى دليل frontend :

    cd frontend

2. تثبيت التبعيات:

   npm install

3. ابدأ خادم التطوير:

   npm run dev

الخلفية

1. انتقل إلى الدليل backend :

    cd backend

2. تثبيت التبعيات:

   npm install

3. إعداد Mongodb Atlas:

   1. انتقل إلى Mongodb Atlas وإنشاء حساب إذا لم يكن لديك بالفعل حساب.
   2. قم بإنشاء مجموعة جديدة باتباع المطالبات. تعليمي إنشاء مجموعة أطلس مونغو أطلس
   3. بمجرد إنشاء الكتلة ، انتقل إلى قسم الوصول إلى قاعدة البيانات وإنشاء مستخدم مع الامتيازات اللازمة.
   4. انتقل إلى الوصول إلى الشبكة واترك عنوان IP الخاص بك (أو السماح للوصول من أي مكان إذا كان الاختبار محليًا).
   5. في قسم المجموعات ، انقر فوق "الاتصال" ، ثم اختر توصيل التطبيق الخاص بك . سترى سلسلة اتصال تبدو هكذا:

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

   6. استبدل <username> و <password> باسم المستخدم وكلمة المرور الفعلية لـ MongoDB ATLAS. انسخ سلسلة الاتصال بأكملها.

4. أضف mongodb atlas_uri إلى ملف .env :

   • إنشاء ملف .env في دليل backend .
   • أضف السطر التالي إلى ملف .env ، واستبدال <your-mongodb-connection-string> مع سلسلة الاتصال التي قمت بنسخها من أطلس mongodb:

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

5. بدء الخادم:

   node server.js

   أو إذا تم تثبيت nodemon للحصول على تحديثات مباشرة من الخلفية:

   nodemon server.js

هيكل المشروع

الواجهة

يحتوي دليل frontend على تطبيق React.

• public : يحتوي على الأصول العامة للتطبيق.
• src : يحتوي على الكود المصدري للتطبيق.
  • components : مكونات واجهة المستخدم القابلة لإعادة الاستخدام.
    • Home : مكونات الصفحة الرئيسية
      • Exercise : مكون صف التمرين لعرض المدة ، الحالة ، DayCheck
      • ExercisesList : لعرض قائمة التمارين التي يقوم بها المستخدم
      • HeatMap : مدعوم من ApexCharts.js لعرض روتين تمرين المستخدم
      • Quotes : من API ninjas وعرض عروض الأسعار بشكل عشوائي لتحفيز المستخدم
      • TotalDays : لعرض عدد الأيام التي يمارسها المستخدم
      • UserExperience : لعرض تجربة المستخدم من خلال تجربة gamified
      • UserRoutine : لعرض الروتين الأسبوعي للمستخدم مثل الخط
    • HomePage : عرض الصفحة الرئيسية وتقديمها
    • Login : عرض صفحة تسجيل الدخول
    • SignUp : عرض صفحة المستخدم وتحريرها
    • navbar : Navbar Component
• App.jsx : المكون الرئيسي الذي يقوم بإعداد الطرق.
• main.jsx : نقطة دخول تطبيق React.

الخلفية

يحتوي دليل backend على خادم Node.js والتطبيق السريع.

• models : يحتوي على مخططات mongoose.
  • exercise.model : مخطط التمرين
  • user.model : مخطط المستخدم
• routes : يحتوي على طرق API.
  • exercises : طرق API الخلفية للتمارين
  • user : طرق API الخلفية للمستخدمين
• server.js : نقطة إدخال تطبيق الخادم.

المساهمة

نرحب بالمساهمات! للمساهمة في Fit-Track ، اتبع هذه الخطوات:

Forking المستودع

1. شوك المستودع من خلال النقر فوق الزر "شوكة" في أعلى يمين صفحة المستودع على Github.

استنساخ المستودع

2. استنساخ مستودعك المتشعب إلى جهازك المحلي:

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

3. انتقل إلى دليل المشروع:

    cd Fit-Track

إنشاء فرع

4. قم بإنشاء فرع جديد للميزة أو إصلاح الأخطاء (قم بإنشاء فرع وفقًا للمشكلة التي تعمل عليها):

   git switch -c your-branch-name

إجراء تغييرات

5. قم بإجراء تغييراتك على قاعدة الشفرة. يمكنك تحرير الملفات باستخدام محرر الرمز المفضل لديك.

ارتكاب التغييرات

6. أضف التغييرات إلى منطقة التدريج:

   git add .

7. ارتكاب التغييرات برسالة وصفية:

   git commit -m " Description of your changes "

دفع التغييرات

8. ادفع التغييرات إلى مستودعك المتشعب:

   git push origin your-branch-name

إنشاء طلب سحب

9. قم بإنشاء طلب سحب من مستودعك المتشعب إلى المستودع الرئيسي. انتقل إلى علامة التبويب "سحب طلبات" في المستودع الرئيسي ، وانقر فوق "طلب سحب جديد". اتبع التعليمات لإنشاء طلب السحب الخاص بك.

هذه مجرد البداية! إنني أتطلع إلى تقديم مساهمات أكثر جدوى والتعاون مع هذا المجتمع المذهل. دعونا نبني شيئًا رائعًا معًا ونجعل المسار المناسب أفضل ما يمكن أن يكون! ❤؟

رخصة

تم ترخيص هذا المشروع بموجب ترخيص معهد ماساتشوستس للتكنولوجيا - راجع ملف الترخيص للحصول على التفاصيل.