Ayurveda GPT

Ayurveda-Gpt

Contribuindo para o Ayurveda GPT ?

Bem -vindo e obrigado pelo seu interesse em contribuir para o Ayurveda GPT , um aplicativo da Web React! Estamos animados por você participar da Hacktoberfest 2024 ! Este guia o levará a como contribuir e as diretrizes a seguir.

---

Começando

Congratulamo -nos com contribuições! Se você tiver sugestões para aprimorar o site ou corrigir problemas existentes, sinta -se à vontade para abrir um problema ou enviar uma solicitação de tração.

Anexe uma captura de tela ou vídeo mostrando o recurso ou correção de bugs que você implementou ao enviar sua solicitação de tração para nos ajudar a revisar sua contribuição com mais eficiência.

Fork o repositório

1. Navegue até o repositório no github: https://github.com/MUDITJAINN/Ayurveda-GPT .
2. Clique no botão do garfo no canto superior direito para criar uma cópia pessoal do repositório.

Clone o repositório

Depois de bifurcar o repositório, clone -o para sua máquina local:

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

Navegue no diretório do projeto:

 cd ayurveda-gpt

Configure o ambiente de desenvolvimento

1. Instale dependências:

   Verifique se você tem o Node.js instalado. Então, corra:

   npm install

2. Inicie o servidor de desenvolvimento:

   npm start

   Isso executará o projeto localmente em http://localhost:3000 .

---

Como contribuir

Congratulamo -nos com todos os tipos de contribuições, seja uma correção de bugs, sugestão de recursos ou melhoria de documentação. Veja como você pode começar:

Fork o repositório

1. Clique no botão do garfo no canto superior direito da página do repositório para criar sua própria cópia.

Clone o repositório

Clone o repositório bifurcado à sua máquina local:

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

Navegue no diretório do projeto:

 cd ayurveda-gpt

Crie uma filial

Crie um novo ramo onde você trabalhará em sua contribuição:

git checkout -b your-branch-name

Por exemplo, se você estiver corrigindo um problema, poderá nomear seu nome fix/issue-name .

Resolver um problema

Encontre um problema na guia Problemas marcada com hacktoberfest , good first issue ou help wanted . Comente o assunto para indicar que você está trabalhando nisso.

Cometer suas mudanças

Depois de fazer suas alterações, encene os arquivos e comprometa -os:

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

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

Envie um pedido de tração

Depois que suas alterações forem comprometidas, empurre seu ramo para o repositório bifurcado:

git push origin your-branch-name

Vá para o repositório original e clique em uma nova solicitação de tração . Forneça uma descrição detalhada de suas alterações.

Se fundir

Aguarde os mantenedores revisarem sua solicitação de tração. Se tudo parecer bom, será fundido. Se forem necessárias alterações, os mantenedores fornecerão feedback.

Diretrizes de código?

COMITES

• Use mensagens de comprometimento conciso e descritivo.
• Exemplo: Add feature for Ayurveda herbs list .

Puxar solicitações

• Verifique se todos os testes passam (se aplicável).
• Siga o estilo de código do projeto e as convenções de nomeação.
• Forneça uma descrição clara e concisa na solicitação de tração.

Estilo de código

• Siga as melhores práticas do React .
• Escreva código limpo, modular e reutilizável .
• Use nomes descritivos de variável e funções.
• Os componentes devem ser o mais pequeno e simples possível.
• Use let e const em vez de var .

Pilha de tecnologia

O projeto é construído usando as seguintes tecnologias:

Front-end:

• React.js : Biblioteca JavaScript para criar interfaces de usuário
• HTML5 & CSS3 : Estruturando e modelando as páginas da web
• JavaScript (ES6+) : recursos javascript modernos e sintaxe
• CSS de Bootstrap/Tailwind : para design e estilo responsivos

Back -end:

• Node.js : ambiente de tempo de execução para executar o JavaScript no servidor
• Express.js : Lightweight Web Framework para Node.js

Banco de dados:

• MongoDB : banco de dados NoSQL para armazenar dados e conteúdo do usuário

Integração da IA:

• API OpenAI GPT-3 : para gerar respostas ayurvédicas personalizadas

Autenticação:

• JWT (JSON Web Token) : Para autenticação segura do usuário

Implantação:

• Netlify : para hospedagem de front -end
• Heroku/Render : para hospedagem de back -end

Mostre seu apoio

Se você achar este projeto útil ou interessante, estrela o repositório ! Seu apoio ajuda a motivar o desenvolvimento de novos recursos e melhorias.

---

Código de Conduta ?

Por favor, siga nosso código de conduta para criar um ambiente positivo, inclusivo e respeitoso para todos os envolvidos.

Feliz hacking! ?

Estamos emocionados por você contribuir para o projeto Ayurveda GPT ! Esteja você corrigindo bugs, adicionando recursos ou melhorando a documentação, sua contribuição é valiosa e apreciada. Obrigado por melhorar este projeto!