Ayurveda GPT

Ayurveda-gpt

Bei Ayurveda GPT beitragen?

Willkommen, und vielen Dank für Ihr Interesse, zu Ayurveda GPT beizutragen, einer React -Webanwendung! Wir freuen uns, dass Sie am Hacktoberfest 2024 teilnehmen! Dieser Leitfaden führt Sie durch den Beitrag und die folgenden Richtlinien.

---

Erste Schritte

Wir begrüßen Beiträge! Wenn Sie Vorschläge zur Verbesserung der Website oder zur Behebung vorhandener Probleme haben, können Sie ein Problem eröffnen oder eine Pull -Anfrage abgeben.

Bitte fügen Sie einen Screenshot oder ein Video hinzu, in dem die Funktion oder Fehlerbehebung vorgestellt wird, die Sie implementiert haben, wenn Sie Ihre Pull -Anfrage senden, um uns dabei zu helfen, Ihren Beitrag effektiver zu überprüfen.

Geben Sie das Repository auf

1. Navigieren Sie zum Repository unter GitHub: https://github.com/MUDITJAINN/Ayurveda-GPT .
2. Klicken Sie oben rechts auf die Schaltfläche Gabel , um eine persönliche Kopie des Repositorys zu erstellen.

Klonen Sie das Repository

Sobald Sie das Repository gegabelt haben, klonen Sie es auf Ihre lokale Maschine:

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

Navigieren Sie in das Projektverzeichnis:

 cd ayurveda-gpt

Richten Sie die Entwicklungsumgebung ein

1. Abhängigkeiten installieren:

   Stellen Sie sicher, dass Sie Node.js installiert haben. Dann rennen Sie:

   npm install

2. Starten Sie den Entwicklungsserver:

   npm start

   Dadurch wird das Projekt lokal unter http://localhost:3000 durchgeführt.

---

Wie man beiträgt

Wir begrüßen alle Arten von Beiträgen, unabhängig davon, ob es sich um eine Fehlerbehebung, einen Feature -Vorschlag oder eine Verbesserung der Dokumentation handelt. So können Sie loslegen:

Geben Sie das Repository auf

1. Klicken Sie oben rechts auf der Schaltfläche Gabel auf der Seite "Repository", um Ihre eigene Kopie zu erstellen.

Klonen Sie das Repository

Klonen Sie das Forked Repository in Ihre lokale Maschine:

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

Navigieren Sie in das Projektverzeichnis:

 cd ayurveda-gpt

Erstellen Sie einen Zweig

Erstellen Sie eine neue Filiale, in der Sie an Ihrem Beitrag arbeiten:

git checkout -b your-branch-name

Wenn Sie beispielsweise ein Problem beheben, können Sie Ihre Filiale fix/issue-name benennen.

Ein Problem lösen

Finden Sie ein Problem aus der Registerkarte hacktoberfest ", good first issue oder Hilfe, oder help wanted . Kommentieren Sie das Problem, um anzuzeigen, dass Sie daran arbeiten.

Verpflichten Sie Ihre Änderungen

Nachdem Sie Ihre Änderungen vorgenommen haben, führen Sie die Dateien auf und begehen Sie sie:

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

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

Senden Sie eine Pull -Anfrage

Sobald Ihre Änderungen festgelegt sind, drücken Sie Ihren Zweig in Ihr Forked Repository:

git push origin your-branch-name

Gehen Sie zum ursprünglichen Repository und klicken Sie auf eine neue Pull -Anfrage . Geben Sie eine detaillierte Beschreibung Ihrer Änderungen an.

Sich verschmolzen

Warten Sie, bis die Betreuer Ihre Pull -Anfrage überprüfen. Wenn alles gut aussieht, wird es zusammengeführt. Wenn Änderungen erforderlich sind, geben die Wartenden Feedback.

Code -Richtlinien?

Sich verpflichtet

• Verwenden Sie prägnante und beschreibende Commit -Nachrichten.
• Beispiel: Add feature for Ayurveda herbs list .

Anfragen ziehen

• Stellen Sie sicher, dass alle Tests bestehen (falls zutreffend).
• Folgen Sie dem Codestil des Projekts und der Namenskonventionen.
• Geben Sie eine klare und präzise Beschreibung in der Pull -Anfrage an.

Codestil

• Folgen Sie React Best Practices .
• Schreiben Sie sauber, modular und wiederverwendbarer Code .
• Verwenden Sie beschreibende Variable und Funktionsnamen.
• Komponenten sollten so klein und einfach wie möglich sein.
• Verwenden Sie let und const anstelle von var .

Tech Stack

Das Projekt wird mit den folgenden Technologien erstellt:

Frontend:

• React.js : JavaScript -Bibliothek zum Erstellen von Benutzeroberflächen
• HTML5 & CSS3 : Strukturieren und Styling der Webseiten
• JavaScript (ES6+) : Moderne JavaScript -Funktionen und Syntax
• Bootstrap/Railwind CSS : Für reaktionsschnelles Design und Styling

Backend:

• Node.js : Laufzeitumgebung zum Ausführen von JavaScript auf dem Server
• Express.js : Leichtes Web Framework für node.js

Datenbank:

• MongoDB : NoSQL -Datenbank zum Speichern von Benutzerdaten und Inhalten

KI -Integration:

• OpenAI GPT-3 API : Zur Erzeugung personalisierter ayurvedischer Reaktionen

Authentifizierung:

• JWT (JSON Web Token) : Für sichere Benutzerauthentifizierung

Einsatz:

• Netlify : Für Frontend -Hosting
• Heroku/Render : Für Backend -Hosting

Zeigen Sie Ihre Unterstützung

Wenn Sie dieses Projekt nützlich oder interessant finden, spielen Sie bitte das Repository ! Ihre Unterstützung motiviert die Entwicklung neuer Funktionen und Verbesserungen.

---

Verhaltenskodex ?

Bitte halten Sie unseren Verhaltenskodex ein, um eine positive, integrative und respektvolle Umgebung für alle Beteiligten zu schaffen.

Frohe Hacking! ?

Wir sind begeistert, dass Sie zum Ayurveda GPT -Projekt beitragen! Egal, ob Sie Fehler beheben, Funktionen hinzufügen oder die Dokumentation verbessern, Ihr Beitrag ist wertvoll und geschätzt. Vielen Dank, dass Sie dieses Projekt besser gemacht haben!