Colaboradores do Projeto

Caio Melo

João Pedro Rodrigues

Marcos Vinicius

Nathan Batista

Júlia dos Reis

Cayo Alencar

História do Projeto

O Projeto de Mapeamento de Obras Públicas do Distrito Federal nasceu da necessidade de otimizar o acompanhamento e a transparência das obras públicas em andamento na região. Com o crescente volume de recursos públicos destinados a investimentos em infraestrutura e desenvolvimento urbano, surgiu a ideia de criar uma ferramenta que facilitasse a visibilidade dessas obras, garantindo uma maior transparência para a população do Distrito Federal.

Tecnologias Usadas

• HTML5
• CSS3
• JavaScript (ES6+)
• Python
• Node.js
• API Obras Gov
• Axios
• Tweepy

Sobre o Grupo

Nós fazemos parte do SQUAD 7 da disciplina de Métodos de Desenvolvimento de Software, ministrada pela professora Carla Rocha, que é composto por estudantes de Engenharia de Software que aplicam conceitos e metodologias de desenvolvimento em projetos reais. O grupo foca na utilização de práticas ágeis, como Scrum, e na integração de técnicas de qualidade, testes e gerenciamento de projetos. Além de promover a aprendizagem prática e colaborativa, o grupo também busca inovação e pesquisa em soluções tecnológicas. Através de projetos como o Mapeamento de Obras Públicas do DF, os alunos têm a oportunidade de aplicar seus conhecimentos em desafios reais, preparando-os para o mercado de trabalho e contribuindo para a sociedade.

Como Subir o Ambiente

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 -r requirements.txt

   • 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

O sistema de mapeamento de obras públicas no DF foi desenvolvido para permitir que qualquer cidadão interessado tenha acesso a dados relevantes referentes ao andamento das obras públicas através de uma aplicação web. A aplicação apresenta um mapa interativo contendo as informações sobre as obras e conta com um robô (Bot) responsável por denunciar anomalias nas obras na rede social X.

O modelo arquitetural adotado no projeto foi o modelo em camadas, devido à facilidade de manutenção, escalabilidade e reutilização de componentes. Isso permite maior flexibilidade e controle das operações, utilizando a modularização do código.

Objetivos com a Escolha da Arquitetura

• Modularidade: Separação de responsabilidades em camadas distintas.
• Escalabilidade: Facilidade de expansão do sistema.
• Manutenibilidade: Facilidade de atualização e correção de erros.
• Desempenho: Otimização da performance sem sacrificar a qualidade do código.

Descrição das Camadas

Camada de Apresentação

Esta é a camada responsável pela interação com o usuário, apresentando a interface web como um mapa interativo com pins clicáveis relacionados diretamente com a localização da obra referenciada. Ao clicar no pin, o usuário visualiza as informações da obra. Foi construída com HTML, CSS e JavaScript.

Camada de Aplicação (Lógica de Negócios)

Esta camada é responsável pelas regras de negócios, interação com outras camadas e APIs externas, e processamento de dados. Atua como a lógica do projeto, dividida em dois componentes:

• Backend: Responsável por gerar o mapa e requisitar as informações das obras através das APIs externas.
• Robô: Detecta anomalias e as reporta através da rede social X.

APIs requisitadas pelo Backend:

• Obras Gov: API que fornece dados necessários sobre as obras públicas.
• Leaflet: API que gera o mapa.

APIs requisitadas pelo Robô (Bot):

• X API: API responsável por enviar as anomalias em formato de tweet à rede social X.
• Cohere: IA generativa que produz mensagens humanizadas para o reporte de anomalias no X.

Camada de Dados

A camada de dados do sistema utiliza arquivos JSON para armazenar as informações. Cada conjunto de dados é representado como um objeto JSON ou uma lista de objetos JSON, que podem ser facilmente manipulados usando bibliotecas e frameworks de parsing JSON. Esses arquivos são armazenados no sistema de arquivos local ou em um repositório de objetos, como um serviço de armazenamento em nuvem.

Documentação do Projeto

Protótipo de baixa fidelidade

Este é nosso protótipo de baixa fidelidade. Sua finalidade é que possamos ter uma ideia de como seriam as telas principais do nosso sistema

Protótipo de alta fidelidade

Navegue pelo nosso protótipo de alta fidelidade do sistema de mapeamento de obras públicas no DF. O protótipo foi criado no Figma

Explore as atas do nosso projeto

Acesse a pasta do nosso projeto no GitHub para obter mais detalhes.