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许可证获得许可的 - 有关详细信息，请参见许可证文件。