Ayurveda GPT

Ayurveda-gpt

Contribuant à l'ayurveda GPT ?

Bienvenue, et merci de votre intérêt à contribuer à Ayurveda GPT , une application Web React! Nous sommes ravis de vous faire participer au Hacktoberfest 2024 ! Ce guide vous guidera dans la façon de contribuer et les directives à suivre.

---

Commencer

Nous accueillons les contributions! Si vous avez des suggestions pour améliorer le site Web ou résoudre les problèmes existants, n'hésitez pas à ouvrir un problème ou à soumettre une demande de traction.

Veuillez joindre une capture d'écran ou une vidéo présentant la fonction ou la correction de bogue que vous avez implémentée lors de la soumission de votre demande de traction pour nous aider à consulter votre contribution plus efficacement.

Fourchez le référentiel

1. Accédez au référentiel sur github: https://github.com/MUDITJAINN/Ayurveda-GPT .
2. Cliquez sur le bouton de la fourche en haut à droite pour créer une copie personnelle du référentiel.

Cloner le référentiel

Une fois que vous avez fourré le référentiel, clonez-le sur votre machine locale:

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

Naviguer dans le répertoire du projet:

 cd ayurveda-gpt

Configurer l'environnement de développement

1. Installez les dépendances:

   Assurez-vous que Node.js est installé. Ensuite, courez:

   npm install

2. Démarrer le serveur de développement:

   npm start

   Cela exécutera le projet localement sur http://localhost:3000 .

---

Comment contribuer

Nous accueillons tous les types de contributions, qu'il s'agisse d'une correction de bogue, d'une suggestion de fonctionnalités ou d'une amélioration de la documentation. Voici comment vous pouvez commencer:

Fourchez le référentiel

1. Cliquez sur le bouton de la fourche en haut à droite de la page du référentiel pour créer votre propre copie.

Cloner le référentiel

Clone le référentiel fourchu à votre machine locale:

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

Naviguer dans le répertoire du projet:

 cd ayurveda-gpt

Créer une branche

Créez une nouvelle branche où vous travaillerez sur votre contribution:

git checkout -b your-branch-name

Par exemple, si vous résolvez un problème, vous pouvez nommer votre fix/issue-name de branche.

Résoudre un problème

Trouvez un problème de l'onglet Issues intitulée hacktoberfest , good first issue ou help wanted . Commentez la question pour indiquer que vous y travaillez.

Engager vos modifications

Après avoir apporté vos modifications, met en scène les fichiers et les engager:

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

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

Soumettre une demande de traction

Une fois vos modifications engagées, poussez votre branche vers votre référentiel à fourche:

git push origin your-branch-name

Accédez au référentiel d'origine et cliquez sur la nouvelle demande de traction . Fournissez une description détaillée de vos modifications.

Être fusionné

Attendez que les mainteneurs examinent votre demande de traction. Si tout semble bon, il sera fusionné. Si des modifications sont nécessaires, les mainteneurs fourniront des commentaires.

Lignes directrices de code?

Engagements

• Utilisez des messages de validation concises et descriptifs.
• Exemple: Add feature for Ayurveda herbs list .

Des demandes de traction

• Assurez-vous que tous les tests passent (le cas échéant).
• Suivez le style de code du projet et les conventions de dénomination.
• Fournissez une description claire et concise dans la demande de traction.

Style de code

• Suivez les meilleures pratiques React .
• Écrivez du code propre, modulaire et réutilisable .
• Utilisez des noms de variables et de fonction descriptifs .
• Les composants doivent être aussi petits et simples que possible.
• Utilisez let et const au lieu de var .

Pile technologique

Le projet est construit en utilisant les technologies suivantes:

L'extrémité avant:

• React.js : bibliothèque javascript pour la construction d'interfaces utilisateur
• HTML5 et CSS3 : structurer et styliser les pages Web
• JavaScript (ES6 +) : fonctionnalités et syntaxe JavaScript moderne
• Bootstrap / Tailwind CSS : pour une conception et un style réactifs

Backend:

• Node.js : environnement d'exécution pour exécuter JavaScript sur le serveur
• Express.js : Framework Web léger pour Node.js

Base de données:

• MongoDB : base de données NoSQL pour stocker les données et le contenu des utilisateurs

Intégration de l'IA:

• API Openai GPT-3 : pour générer des réponses ayurvédiques personnalisées

Authentification:

• JWT (jeton Web JSON) : pour une authentification des utilisateurs sécurisés

Déploiement:

• Netlify : pour l'hébergement frontal
• Heroku / Render : pour l'hébergement backend

Montrez votre soutien

Si vous trouvez ce projet utile ou intéressant, veuillez jouer le référentiel ! Votre soutien aide à motiver le développement de nouvelles fonctionnalités et d'améliorations.

---

Code de conduite ?

Veuillez adhérer à notre code de conduite pour créer un environnement positif, inclusif et respectueux pour toutes les personnes impliquées.

Joyeux piratage! ?

Nous sommes ravis de vous faire contribuer au projet Ayurveda GPT ! Que vous fixiez des bogues, de l'ajout de fonctionnalités ou de l'amélioration de la documentation, votre contribution est précieuse et appréciée. Merci d'avoir amélioré ce projet!