Ayurveda GPT

阿育吠陀-GPT

为阿育吠陀GPT做出贡献？

欢迎您，并感谢您对React Web应用程序Ayurveda GPT做出贡献的兴趣！我们很高兴您参加Hacktoberfest 2024 ！本指南将带您完成如何贡献和遵循的准则。

---

入门

我们欢迎捐款！如果您有提高网站或修复现有问题的建议，请随时打开问题或提交拉动请求。

请附上屏幕截图或视频，以显示您在提交拉动请求时已实现的功能或错误修复程序，以帮助我们更有效地查看您的贡献。

分叉存储库

1. 导航到GitHub上的存储库： https://github.com/MUDITJAINN/Ayurveda-GPT 。
2. 单击右上角的叉按钮以创建存储库的个人副本。

克隆存储库

分配存储库后，将其克隆到您的本地计算机上：

git clone https://github.com/YOUR-USERNAME/ayurveda-gpt.git

导航到项目目录：

 cd ayurveda-gpt

建立开发环境

1. 安装依赖项：

   确保已安装了node.js。然后，运行：

   npm install

2. 启动开发服务器：

   npm start

   这将通过http://localhost:3000在本地运行该项目。

---

如何贡献

我们欢迎所有类型的贡献，无论是错误修复，功能建议还是文档改进。这是您可以开始的方法：

分叉存储库

1. 单击“存储库”页面右上角的叉按钮以创建自己的副本。

克隆存储库

克隆分叉存储库到您本地机器：

git clone https://github.com/YOUR-USERNAME/ayurveda-gpt.git

导航到项目目录：

 cd ayurveda-gpt

创建一个分支

创建一个新的分支，您将在其中进行贡献：

git checkout -b your-branch-name

例如，如果您要解决问题，则可以命名分支fix/issue-name 。

解决问题

从“问题”选项卡中查找标有hacktoberfest ， good first issue或help wanted问题。评论该问题，以表明您正在研究它。

提交您的更改

进行更改之后，登台文件并提交文件：

git add .
git commit -m " Detailed description of your changes "

示例： Fix: Resolved issue with missing alt attributes in images.

提交拉请请求

一旦提交更改，将分支推到叉子库：

git push origin your-branch-name

转到原始存储库，然后单击新的拉请请求。提供有关您的更改的详细说明。

合并

等待维护者查看您的拉请请求。如果一切看起来都不错，它将合并。如果需要更改，维护者将提供反馈。

代码指南？

提交

• 使用简洁和描述性提交消息。
• 示例： Add feature for Ayurveda herbs list 。

拉请求

• 确保所有测试通过（如果适用）。
• 遵循项目的代码样式和命名约定。
• 在拉动请求中提供清晰简洁的描述。

代码样式

• 关注React最佳实践。
• 编写干净，模块化和可重复使用的代码。
• 使用描述性变量和函数名称。
• 组件应尽可能小而简单。
• 使用let和const而不是var 。

技术堆栈

该项目是使用以下技术构建的：

前端：

• react.js ：用于构建用户界面的JavaScript库
• HTML5＆CSS3 ：结构和样式网页
• JavaScript（ES6+） ：现代JavaScript功能和语法
• Bootstrap/tailwind CSS ：用于响应式设计和样式

后端：

• node.js ：用于在服务器上执行JavaScript的运行时环境
• express.js ：node.js轻量级网络框架

数据库：

• MongoDB ：用于存储用户数据和内容的NOSQL数据库

AI集成：

• OpenAI GPT-3 API ：用于产生个性化的阿育吠陀响应

验证：

• JWT（JSON Web令牌） ：用于安全的用户身份验证

部署：

• Netlify ：用于前端托管
• Heroku/Render ：用于后端托管

表示您的支持

如果您发现此项目有用或有趣，请标记存储库！您的支持有助于激发新功能和改进的发展。

---

行为守则 ？

请遵守我们的行为守则，为参与的每个人创造一个积极，包容和尊重的环境。

快乐黑客！ ？

我们很高兴您能为Ayurveda GPT项目做出贡献！无论您是修复错误，添加功能还是改进文档，您的贡献都是有价值的和赞赏的。感谢您使这个项目变得更好！