readme generator

Projeto Gerador README

Visão geral do projeto

Bem-vindo ao projeto README Generator! Esta ferramenta inovadora foi projetada para agilizar o processo de criação de arquivos README para projetos de software. Ao aproveitar o poder da IA ​​generativa, ele permite que os usuários insiram uma breve descrição de seu projeto, incluindo sua finalidade, recursos e detalhes técnicos, e gera um arquivo README.md bem estruturado e informativo seguindo as melhores práticas.

? Características

• Interface amigável : A interface da web fornece uma maneira intuitiva de inserir detalhes do projeto e gerar arquivos README sem esforço.
• Entrada dinâmica de arquivos : os usuários podem adicionar vários arquivos com nomes personalizados e trechos de código, permitindo documentação abrangente dos componentes do projeto.
• Geração dinâmica de README : gera automaticamente arquivos README com base na entrada do usuário.
• Integração de IA generativa : utiliza o modelo de IA generativa para gerar arquivos README com base na entrada do usuário, garantindo precisão e relevância.
• Configuração personalizável : os usuários podem definir configurações de geração, como temperatura, top p, top k e configurações de segurança para personalizar a saída de acordo com suas preferências.
• Conteúdo alimentado por IA : utiliza IA generativa para criar conteúdo envolvente e informativo.
• Customizável : Permite que os usuários personalizem o arquivo README de acordo com as necessidades do seu projeto.
• Suporte Emoji : aprimora o README com emojis para uma experiência de usuário mais envolvente.

Detalhes técnicos

O projeto README Generator é construído com uma combinação de Flask para backend e Express.js para frontend. Ele usa o modelo Google Generative AI para gerar o conteúdo README, garantindo resultados relevantes e de alta qualidade.

Back-end ( app.py )

O backend é responsável por lidar com a geração do conteúdo README. Ele recebe informações do usuário, processa-as e se comunica com o modelo generativo de IA para gerar o README.

Front-end ( public/app.js )

O frontend fornece uma interface de usuário interativa para os usuários inserirem os detalhes do projeto e gerarem o README. Ele se comunica com o backend para enviar a entrada do usuário e receber o README gerado.

Começando

Para executar o README GPT? localmente, siga estas etapas:

1. Clone o repositório: git clone https://github.com/chiragjoshi12/readme-generator.git
2. Navegue até o diretório do projeto: cd readme-generator
3. Instale dependências:
   • Para back-end do Flask:

      cd backend
     pip install -r requirements.txt
     

   • Para front-end Node.js:

      cd public
     npm install
     

4. Configure variáveis ​​de ambiente:
   • Crie um arquivo .env no diretório backend e adicione sua chave API Generative AI:

      GENERATIVE_AI_API_KEY=your_api_key_here
     

5. Inicie o servidor Flask: python app.py
6. Inicie o servidor Node.js para o frontend:

Uso

1. Abra seu navegador da web e navegue até http://localhost:3000 .
2. Clique em "Adicionar arquivo" para inserir os detalhes do seu projeto.
3. Preencha o nome do arquivo e as seções de código.
4. Clique em "Gerar README" para gerar seu arquivo README.

? Contribuindo

Sinta-se à vontade para contribuir e melhorar este projeto!

? Contato

Se você tiver alguma dúvida ou sugestão, sinta-se à vontade para entrar em contato com Chirag Joshi pelo e-mail [email protected].

---

Feito com ❤️ por Chirag Joshi

Obrigado por usar o README GPT?!