unb-mds / 2024-2-InfraTranDF

O InfraTranDF é uma plataforma acessível e intuitiva que permite aos cidadãos do Distrito Federal acompanhar infrações de trânsito de forma detalhada. A proposta é tornar as informações sobre segurança viária mais transparentes e de fácil acesso, incentivando a conscientização e a melhoria do trânsito local.
MIT License
6 stars 0 forks source link

Aqui está uma versão diferenciada em markdown:


InfraTranDF

O InfraTranDF é uma iniciativa da disciplina Métodos de Desenvolvimento de Software com o propósito de criar uma plataforma intuitiva, onde cidadãos possam ter acesso e reportar informações sobre infrações e multas de trânsito no Distrito Federal. A ideia central é facilitar o acesso e a transparência, permitindo que usuários possam:

Este projeto é distribuído como software livre, sob a licença MIT.

📑 Índice

👤 Equipe


Artur Handow Krauspenhar

Diassis Bezerra Nascimento

Eduardo de Almeida Morais

Filipe Bressanelli Azevedo Filho

Gustavo Gontijo Lima

Leonardo Henrique Sobral Sauma Junior

🚀 Primeiros Passos

Para clonar este repositório, execute:

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

🛠 Pré-requisitos

Antes de rodar o projeto, instale as seguintes ferramentas:

⚙️ Configuração do Ambiente

Para configurar o ambiente de desenvolvimento, execute:

make config

📦 Instalação das Dependências

Execute os seguintes comandos para instalar as dependências:

# Crie o ambiente virtual do Python
python3 -m venv api/env

# Ative o ambiente virtual
source api/env/bin/activate

# Instale as bibliotecas para Python e Node
make install

▶️ Execução do Projeto

Para iniciar o projeto, rode:

docker compose up

Sobre o Docker

Para usos específicos do Docker, veja abaixo:

# Executar em segundo plano
docker compose up -d

# Reconstruir imagens após mudanças no Dockerfile
docker compose up --build

# Remover volumes, se necessário
docker compose down -v
# Atualizar a base de dados para os períodos desejados
make updatedb-all

# Comando alternativo
docker exec django-api python3 ./manage.py updatedb -a

📖 Documentação

Acesse a documentação completa do projeto aqui.

🔗 Links Úteis

Diagrama de Arquitetura

Protótipo Visual