fit track

Fit-Track

Fit-Track是使用Mern（MongoDB，Express，React+Vite，Node.js）堆棧構建的練習日誌跟踪應用程序。本文檔將指導您完成為該項目做出貢獻的過程。

目錄

• 安裝
  • 前端
  • 後端
• 貢獻
  • 分叉存儲庫
  • 克隆存儲庫
  • 創建一個分支
  • 進行更改
  • 進行更改
  • 推動變化
  • 創建拉力請求
• 執照

安裝

前端

1. 導航到frontend目錄：

    cd frontend

2. 安裝依賴項：

   npm install

3. 啟動開發服務器：

   npm run dev

後端

1. 導航到backend目錄：

    cd backend

2. 安裝依賴項：

   npm install

3. 設置MongoDB地圖集：

   1. 前往MongoDB Atlas，如果您還沒有一個帳戶，請創建一個帳戶。
   2. 通過遵循提示來創建一個新的群集。 Mongo Atlas集群創建教程
   3. 創建群集後，請轉到數據庫訪問部分，並具有必要的特權創建用戶。
   4. 轉到網絡訪問並允許您的IP地址（或在本地測試時允許在任何地方訪問）。
   5. 在“群集”部分中，單擊“連接” ，然後選擇“連接您的應用程序” 。您會看到一個看起來像這樣的連接字符串：

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

   6. 用您的實際MongoDB Atlas用戶名和密碼替換<username>和<password> 。複製整個連接字符串。

4. 將mongodb atlas_uri添加到.env文件：

   • 在backend目錄中創建.env文件。
   • 將以下行添加到.env文件中，用您從mongodb atlas複製的連接字符串替換<your-mongodb-connection-string> ：

     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 ：可重複使用的UI組件。
    • Home ：主頁組件
      • Exercise ：練習行組件以顯示持續時間，狀態，日用
      • ExercisesList ：顯示用戶完成的練習列表
      • HeatMap ：由Apexcharts.js提供動力以顯示用戶鍛煉程序
      • Quotes ：從API Ninjas，並隨機顯示報價以激髮用戶
      • TotalDays ：顯示用戶行使的天數
      • UserExperience ：以遊戲體驗顯示用戶體驗
      • UserRoutine ：像條紋一樣顯示用戶的每週例行程序
    • HomePage ：顯示和渲染主頁
    • Login ：顯示登錄頁面
    • SignUp ：顯示註冊並編輯用戶頁面
    • navbar ：Navbar組件
• App.jsx ：設置路由的主要組件。
• main.jsx ：React應用程序的入口點。

後端

backend目錄包含node.js服務器和Express應用程序。

• models ：包含貓鼬模式。
  • exercise.model ：運動模式
  • user.model ：用戶架構
• routes ：包含API路由。
  • exercises ：練習的後端API路線
  • user ：用戶的後端API路由
• server.js ：服務器應用程序的輸入點。

貢獻

我們歡迎捐款！為了為Fit-Track做出貢獻，請按照以下步驟：

分叉存儲庫

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. 創建從叉子存儲庫到主存儲庫的拉動請求。轉到主存儲庫上的“拉請求”選項卡，然後單擊“新拉請求”。按照說明創建您的拉請請求。

這只是開始！我期待做出更有意義的貢獻，並與這個驚人的社區合作。讓我們一起構建一些偉大的東西，使Fit-Track成為最好的！ ❤️？

執照

該項目是根據MIT許可證獲得許可的 - 有關詳細信息，請參見許可證文件。