Skip to content

unb-mds/MDS-MonitoraBSB

Repository files navigation

Mapeamento de Obras e Serviços Públicos

License: MIT GitHub issues GitHub contributors GitHub stars Hit Counter
Python version React version Django version Docker version Docker Compose version

📋 Descrição

O projeto de Mapeamento de Obras e Serviços Públicos é um sistema de mapeamento interativo que extrai e apresenta informações sobre obras e serviços públicos anunciados nos diários oficiais. Ele permite que cidadãos acompanhem o progresso, a localização e os detalhes dessas iniciativas, promovendo transparência e facilitando o acesso a informações sobre o uso de recursos públicos em suas regiões.

📎 Funcionalidades

  • Extração de Dados: Captura de informações sobre obras e serviços dos diários oficiais.
  • Processamento e Filtragem: Análise de dados para selecionar as informações mais relevantes, como local, tipo de obra, status e valor investido.
  • Exibição em Mapa: Integração com um mapa interativo, onde os cidadãos podem visualizar as obras e serviços por localização geográfica.
  • Acompanhamento de Status: Atualizações sobre o andamento de cada obra ou serviço, categorizadas por status (Planejamento, Em Execução, Concluída).
  • Busca e Filtros Avançados: Permite que usuários filtrem obras por tipo, região, status e valores envolvidos.

📋 Pré-requisitos

Para rodar o projeto, você precisa instalar as dependências globais:

  • Docker
  • Docker Compose
  • Git

💻 Ambiente

Para configurar o ambiente, siga os passos:

  1. Clone o repositório:
git clone https://github.com/unb-mds/MDS-MonitoraBSB/
cd MDS-MonitoraBSB
  1. Crie o arquivo .env na raiz do projeto:
touch .env
  1. Adicione as seguintes variáveis de configuração no arquivo .env:
# Configurações de Banco de Dados
SECRET_KEY=sua_chave_secreta_aqui
POSTGRES_DB=nome_do_banco
POSTGRES_USER=usuario_do_banco
POSTGRES_PASSWORD=senha_do_banco
POSTGRES_PORT=5432
POSTGRES_HOST=postgres
DATABASE_URL=postgresql://usuario:senha@host:porta/nome_do_banco

Importante: Substitua os valores de exemplo pelas suas próprias configurações

💾 Execução

Para executar o projeto, use o seguinte comando:

docker compose up --build

# Se for necessário deletar os volumes
docker compose down -v 

🖱️ Acesso aos serviços

Serviço URL
Frontend http://localhost:5173
Backend http://localhost:5000

📚 Documentação

A documentação do projeto pode ser encontrada clicando aqui.

👥 Equipe


Erick Alves


Beatriz Lins


Paulo Cerqueira


Danie Ferreira Nunes


Daniel Nunes Duarte


Gustavo Lima Menezes

📍 Licença

Este projeto está licenciado sob a MIT License.