Ayurveda-GPT

Contributing to Ayurveda GPT :leaves: :green_heart:

Welcome, and thank you for your interest in contributing to Ayurveda GPT, a React Web Application! We’re excited to have you participate in Hacktoberfest 2024! This guide will walk you through how to contribute and the guidelines to follow.

Getting Started :rocket:

We welcome contributions! If you have suggestions to enhance the website or fix existing issues, please feel free to open an issue or submit a pull request.

Please attach a screenshot or video showcasing the feature or bug fix you have implemented when submitting your pull request to help us review your contribution more effectively.

Fork the Repository

1. Navigate to the repository on GitHub: https://github.com/MUDITJAINN/Ayurveda-GPT.
2. Click the Fork button at the top right to create a personal copy of the repository.

Clone the Repository

Once you've forked the repository, clone it to your local machine:

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

Navigate into the project directory:

cd ayurveda-gpt

Set up the Development Environment

1. Install dependencies:

   Make sure you have Node.js installed. Then, run:

   npm install

2. Start the development server:

   npm start

   This will run the project locally at http://localhost:3000.

How to Contribute :sparkles:

We welcome all types of contributions, whether it's a bug fix, feature suggestion, or documentation improvement. Here’s how you can get started:

Fork the Repository

1. Click the Fork button at the top right of the repository page to create your own copy.

   Clone the Repository

   Clone the forked repository to your local machine:

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

   Navigate into the project directory:

   cd ayurveda-gpt

   Create a Branch

   Create a new branch where you’ll work on your contribution:

   git checkout -b your-branch-name

   For example, if you’re fixing an issue, you could name your branch fix/issue-name.

   Solve an Issue

   Find an issue from the Issues tab labeled hacktoberfest, good first issue, or help wanted. Comment on the issue to indicate that you are working on it.

   Commit Your Changes

   After making your changes, stage the files and commit them:

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

   Example: Fix: Resolved issue with missing alt attributes in images.

   Submit a Pull Request

   Once your changes are committed, push your branch to your forked repository:

   git push origin your-branch-name

   Go to the original repository and click New Pull Request. Provide a detailed description of your changes.

   Get Merged

   Wait for the maintainers to review your pull request. If everything looks good, it will be merged. If changes are required, the maintainers will provide feedback.

   Code Guidelines :page_with_curl:

   Commits

   • Use concise and descriptive commit messages.
   • Example: Add feature for Ayurveda herbs list.

     Pull Requests

   • Make sure all tests pass (if applicable).
   • Follow the project’s code style and naming conventions.
   • Provide a clear and concise description in the pull request.

     Code Style

   • Follow React best practices.
   • Write clean, modular, and reusable code.
   • Use descriptive variable and function names.
   • Components should be as small and simple as possible.
   • Use let and const instead of var.

Tech Stack

The project is built using the following technologies:

Frontend:

• React.js: JavaScript library for building user interfaces
• HTML5 & CSS3: Structuring and styling the web pages
• JavaScript (ES6+): Modern JavaScript features and syntax
• Bootstrap/Tailwind CSS: For responsive design and styling

Backend:

• Node.js: Runtime environment for executing JavaScript on the server
• Express.js: Lightweight web framework for Node.js

Database:

• MongoDB: NoSQL database for storing user data and content

AI Integration:

• OpenAI GPT-3 API: For generating personalized Ayurvedic responses

Authentication:

• JWT (JSON Web Token): For secure user authentication

Deployment:

• Netlify: For frontend hosting
• Heroku/Render: For backend hosting

Show Your Support

If you find this project useful or interesting, please star the repository! Your support helps motivate the development of new features and improvements.

Code of Conduct :handshake:

Please adhere to our Code of Conduct to create a positive, inclusive, and respectful environment for everyone involved.

Happy Hacking! :tada:

We’re thrilled to have you contribute to the Ayurveda GPT project! Whether you’re fixing bugs, adding features, or improving documentation, your contribution is valuable and appreciated. Thank you for making this project better!