NLW IA MASTERY

O nosso projeto é uma ferramenta inovadora e prática projetada para simplificar a criação de títulos e descrições de vídeos. Ela foi desenvolvida com o propósito de atender às necessidades de criadores de conteúdo, empresas de marketing digital e qualquer pessoa que deseje otimizar a apresentação de vídeos em plataformas online.

Instruções de Instalação

Siga estas etapas para executar o projeto em seu ambiente local.

Requisitos do Sistema

• Sistema Operacional: Windows 10, macOS 10.15 ou Linux Ubuntu 20.04
• Node.js (versão 18)
• NPM (gerenciador de pacotes do Node.js)
• OpenAI Key

Passo 1: Clone o Repositório

git clone https://github.com/StephHoel/NLW-IA-MASTERY.git
cd NLW-IA-MASTERY

Passo 2: Instale as Dependências

Dentro do diretório existem 2 projetos (api e web), execute os seguintes comandos para instalar as dependências de ambos os projetos:

cd upload-ai-api
npm install
cd ../upload-ai-web
npm install

Passo 3: Execute os Projetos

Após a configuração, você pode iniciar os projetos de dentro do diretório de cada projeto:

Web:

npm run dev

Api:

npm run dev

O projeto WEB estará disponível em http://localhost:5173 e a API em http://localhost:3333.

Teste a Instalação

Abra seu navegador e acesse http://localhost:5173. Você deve ver a página inicial do projeto.

Atualizações e Atualizações

Para manter o projeto atualizado, você pode usar o seguinte comando:

git pull origin main

Certifique-se de verificar regularmente o repositório para atualizações e seguir as instruções específicas de atualização, se houver.

Solução de Problemas

Se encontrar algum problema durante a instalação ou operação do projeto, entre em contato ou abra uma issue para obter suporte.

Contribuição

Agradecemos por considerar contribuir com o projeto. Sua ajuda é essencial para tornar este projeto melhor para todos os usuários. Aqui estão algumas maneiras pelas quais você pode contribuir:

Relatando Problemas

• Se você encontrar bugs, problemas de usabilidade ou tiver sugestões de melhorias, abra uma issue no nosso repositório.

• Certifique-se de fornecer o máximo de detalhes possível, incluindo passos para reproduzir o problema, mensagens de erro e informações sobre o ambiente em que o problema ocorreu.

Contribuindo com Código

• Se você é um desenvolvedor e deseja contribuir com código, siga estas etapas:
  1. Faça um fork do repositório.
  2. Crie uma nova branch para sua contribuição: git checkout -b minha-contribuicao
  3. Faça suas alterações e adições.
  4. Certifique-se de testar suas alterações.
  5. Faça commit das alterações: git commit -m 'Adiciona minha contribuição'
  6. Faça push para o seu fork: git push origin minha-contribuicao
  7. Abra um pull request no nosso repositório, descrevendo suas alterações em detalhes.

Melhorando a Documentação

• Se você é bom em documentação, pode ajudar a melhorar a documentação existente ou criar documentação adicional para o projeto.

• Para editar a documentação, faça um fork do repositório, faça suas alterações e siga as etapas 4 a 7 descritas acima para contribuições de código.

Testando

• Testar o projeto em diferentes ambientes e relatar problemas de compatibilidade é uma contribuição valiosa.

Compartilhando e Divulgando

Ajude a divulgar o projeto em suas redes sociais, blogs ou comunidades relevantes.

Agradecemos antecipadamente por sua contribuição e esperamos trabalhar com você para tornar este projeto ainda melhor!

Licença

Este projeto está licenciado sob a Licença MIT.