KTTzoo é uma plataforma dedicada à divulgação e preservação da cultura do Catete, um bairro icônico do Rio de Janeiro. O principal recurso do nosso site é um tradutor exclusivo de Português-BR para Gualin do TTK, uma língua única criada no Catete durante a época da ditadura militar.

Para rodar o projeto localmente, siga estes passos:

1. Clone o repositório:

   git clone https://github.com/Grillekkj/kttzoo.git

2. Navegue até o diretório do projeto:

   cd kttzoo

3. Instale as dependências:

   npm install

4. Configure as variáveis de ambiente: Crie uma cópia do arquivo .env.example e renomeie para .env. Em seguida, preencha as informações necessárias. A chave para a API do Google Gemini pode ser obtida em Google AI Studio.

5. Realize o build do servidor backend:

   npm run build

6. Inicie o servidor backend:

   npm run start:prod

Após seguir esses passos, o backend estará rodando em http://localhost:3000 (ou na porta que você configurou) e também estará acessível pelo IP de rede da sua máquina.

Aqui estão os próximos passos planejados para o projeto. Sinta-se à vontade para pegar uma tarefa e contribuir!

• Desenvolver o frontend da aplicação
• Documentar como iniciar o servidor do frontend.
• Aprimorar o prompt da IA para melhorar a qualidade das respostas.
• Aprimorar o algoritmo de tradução para melhorar a qualidade das respostas.
• Criar um banco de dados para funcionar como acervo histórico, contendo documentos sobre a Gualín, o TTK e outras expressões culturais, que também serão exibidos no site.
• Adicionar documentação da API utilizando Swagger/OpenAPI.
• Implementar cobertura de testes, incluindo testes unitários e de integração.

Estamos sempre em busca de colaboradores que possam ajudar a melhorar e expandir nossa plataforma. Aqui estão algumas maneiras de contribuir:

1. 💻 Código: Se você é um desenvolvedor, sinta-se à vontade para fazer fork do projeto, fazer suas alterações e enviar um pull request.
2. 📝 Documentação: Melhorias na documentação ou traduções são sempre bem-vindas.
3. 📣 Divulgação: Compartilhe nosso projeto em suas redes sociais e ajude a aumentar a conscientização sobre a rica cultura do Catete.
4. 🎨 Mídias: Se você tem habilidades em design, vídeo ou outras mídias, sua ajuda será muito apreciada para melhorar a visibilidade do projeto.
5. 💰 Financiamento: Se você deseja apoiar o projeto financeiramente, entre em contato conosco via email [email protected].
6. 🤝 Parcerias: Para propostas de parceria, entre em contato diretamente via email [email protected].

Gostaríamos de agradecer a todos que contribuíram e ajudaram a moldar este projeto:

• Paulo Bento
• Jorge Aguiar
• Pedro Girondi
• Felipe Vital