2024-2-Squad07

Este repositório será utilizado pelo Grupo 7 para o desenvolvimento de um projeto da disciplina de Métodos de Desenvolvimento de Software. O projeto se trata da construção de um software de Mapeamento de Obras e Serviços Públicos.

📋 Sumário

• 👥 Grupo 07
• 📌 Tecnologias Utilizadas
• 🚀 Como Contribuir
• 🛠️ Arquitetura
• 📄 Requisitos
• 📂 Documentação
• 💡 Suporte

👥 Grupo 07

Nome	GitHub
Cayo Felipe Alencar Câmara	Cayoalencar
João Pedro Rodrigues Gomes da Silva	JpRodrigues2
Julia dos Reis Teixeira Massuda	JuliaReis18
Caio Melo Borges	CaioMelo25
Marcos Vinícius Lima Bezerra	marcoslbz
Nathan Batista Santos	Nathan-bs

📌 Tecnologias Utilizadas

• Node.js
• Axios
• Leaflet.js
• Python
• Tweepy
• Cohere API

🚀 Como Contribuir

Se você deseja contribuir com este projeto, siga os passos abaixo para configurar o ambiente e começar a colaborar:

Pré-requisitos

Certifique-se de ter as seguintes ferramentas instaladas:

• Node.js e npm (Node Package Manager)
• Python 3.8+
• pip para gerenciar pacotes Python
• Git para versionamento de código
• dotenv para gerenciar variáveis de ambiente

Passo a Passo

1. Clone o Repositório

   git clone https://github.com/unb-mds/2024-2-Squad07
   cd 2024-2-Squad07

2. Configuração do Backend em Node.js

   • Navegue até o diretório do projeto em Node.js.

   cd ObrasGov

   • Instale as dependências.

   npm install

3. Configuração do Mapa

   • Navegue até o diretório do mapa.

   cd Mapa

   • Instale as dependências.

   npm install

4. Configuração do BOT

   • Navegue até o diretório BOT.

   cd Bots

   • Instale as dependências do Python.

   pip install tweepy
   pip install cohere
   pip install python-dotenv

   • Crie um arquivo .env no diretório principal do projeto e adicione as variáveis de ambiente necessárias, como chaves de API para o Cohere e Tweepy.

5. Executando o Projeto

   • Para rodar o backend em Node.js:

     npm start

   • Para rodar o frontend:

     npm start

   • Para executar os scripts Python:

     python bot_Twitter.py

6. Testes e Pull Requests

   • Teste suas alterações localmente para garantir que tudo funciona como esperado.
   • Crie uma nova branch para suas alterações.

     git checkout -b minha-nova-feature

   • Faça commit das alterações e envie para o repositório.

     git add .
     git commit -m "Descrição das alterações"
     git push origin minha-nova-feature

   • Abra um Pull Request descrevendo suas contribuições.

🛠️ Arquitetura

A arquitetura do projeto pode ser encontrada neste link.

📄 Requisitos

Os requisitos do projeto estão disponíveis neste link.

📂 Documentação

A documentação do projeto pode ser encontrada neste link.

💡 Suporte

Se encontrar problemas durante a configuração, abra uma issue no repositório ou entre em contato.