Ayurveda GPT

Ayurveda-gpt

¿Contribuyendo a Ayurveda GPT ?

¡Bienvenido, y gracias por su interés en contribuir a Ayurveda GPT , una aplicación web React! ¡Estamos emocionados de que participes en Hacktoberfest 2024 ! Esta guía lo guiará a través de cómo contribuir y las pautas a seguir.

---

Empezando

¡Agradecemos las contribuciones! Si tiene sugerencias para mejorar el sitio web o solucionar los problemas existentes, no dude en abrir un problema o enviar una solicitud de extracción.

Adjunte una captura de pantalla o un video que muestre la función o corrección de errores que ha implementado al enviar su solicitud de extracción para ayudarnos a revisar su contribución de manera más efectiva.

Bifurca el repositorio

1. Navegue al repositorio en GitHub: https://github.com/MUDITJAINN/Ayurveda-GPT .
2. Haga clic en el botón de la horquilla en la parte superior derecha para crear una copia personal del repositorio.

Clonar el repositorio

Una vez que haya bifurcado el repositorio, clono a su máquina local:

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

Navegue al directorio del proyecto:

 cd ayurveda-gpt

Configurar el entorno de desarrollo

1. Instalar dependencias:

   Asegúrese de tener Node.js instalado. Entonces, corre:

   npm install

2. Inicie el servidor de desarrollo:

   npm start

   Esto ejecutará el proyecto localmente en http://localhost:3000 .

---

Cómo contribuir

Damos la bienvenida a todo tipo de contribuciones, ya sea una solución de errores, sugerencia de características o mejora de la documentación. Así es como puedes comenzar:

Bifurca el repositorio

1. Haga clic en el botón de la horquilla en la parte superior derecha de la página del repositorio para crear su propia copia.

Clonar el repositorio

Clon el repositorio bifurcado a su máquina local:

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

Navegue al directorio del proyecto:

 cd ayurveda-gpt

Crear una rama

Cree una nueva rama donde trabaje en su contribución:

git checkout -b your-branch-name

Por ejemplo, si está solucionando un problema, puede nombrar fix/issue-name .

Resolver un problema

Encuentre un problema de la pestaña de problemas etiquetada hacktoberfest , good first issue o help wanted . Comente sobre el tema para indicar que está trabajando en ello.

Comprende tus cambios

Después de hacer sus cambios, organice los archivos y confídalos:

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

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

Envíe una solicitud de extracción

Una vez que sus cambios se comprometan, empuje su rama a su repositorio bifurcado:

git push origin your-branch-name

Vaya al repositorio original y haga clic en una nueva solicitud de extracción . Proporcione una descripción detallada de sus cambios.

Fusionarse

Espere a que los mantenedores revisen su solicitud de extracción. Si todo se ve bien, se fusionará. Si se requieren cambios, los mantenedores proporcionarán comentarios.

¿Directrices de código?

Compromiso

• Use mensajes de confirmación concisos y descriptivos.
• Ejemplo: Add feature for Ayurveda herbs list .

Solicitud de solicitud

• Asegúrese de que todas las pruebas pasen (si corresponde).
• Siga el estilo de código del proyecto y las convenciones de nombres.
• Proporcione una descripción clara y concisa en la solicitud de extracción.

Estilo de código

• Siga las mejores prácticas de React .
• Escribe código limpio, modular y reutilizable .
• Use nombres de funciones de variable y funciones descriptivas .
• Los componentes deben ser lo más pequeños y simples posible.
• Use let y const en lugar de var .

Pila de tecnología

El proyecto se crea utilizando las siguientes tecnologías:

Interfaz:

• React.js : Biblioteca JavaScript para construir interfaces de usuario
• HTML5 y CSS3 : Estructuración y diseño de las páginas web
• JavaScript (ES6+) : características modernas de JavaScript y sintaxis
• Bootstrap/Tailwind CSS : para diseño y estilo receptivos

Backend:

• Node.js : entorno de tiempo de ejecución para ejecutar JavaScript en el servidor
• Express.js : marco web ligero para node.js

Base de datos:

• MongoDB : Base de datos NoSQL para almacenar datos y contenido del usuario

Integración de IA:

• API OPERAI GPT-3 : para generar respuestas ayurvédicas personalizadas

Autenticación:

• JWT (JSON Web Token) : para autenticación segura del usuario

Despliegue:

• Netlify : para alojamiento de frontend
• Heroku/Render : para el alojamiento de backend

Muestra tu apoyo

Si encuentra este proyecto útil o interesante, ¡ estrella el repositorio ! Su apoyo ayuda a motivar el desarrollo de nuevas características y mejoras.

---

Código de conducta ?

Adhiera nuestro código de conducta para crear un entorno positivo, inclusivo y respetuoso para todos los involucrados.

¡Feliz piratería! ?

¡Estamos encantados de que contribuya al proyecto Ayurveda GPT ! Ya sea que esté arreglando errores, agregando características o mejorando la documentación, su contribución es valiosa y apreciada. ¡Gracias por mejorar este proyecto!