README.md

Aqui está uma versão diferenciada em markdown:

---

ChamaControl

O ChamaControl é 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 monitorar informações sobre queimadas que possam estar acontecendo pelo território brasileiro. A ideia central é facilitar o acesso e a transparência, permitindo que usuários possam:

• Visualizar Informações sobre Queimadas: Consultar facilmente registros, condições climáticas alarmantes e alertas de possíveis ocorrências de queimadas.
• Receber alertas personalizados: Usuários podem filtrar determinada área do território para receber alertas.

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

📑 Índice

• ChamaControl
  • 📑 Índice
  • 👤 Equipe
  • 🚀 Primeiros Passos
    • 🛠 Pré-requisitos
    • ⚙️ Configuração do Ambiente
    • 📦 Instalação das Dependências
    • ▶️ Execução do Projeto
      • Sobre o Docker
  • 📖 Documentação
  • 🔗 Links Úteis
    • Diagrama de Arquitetura
    • Protótipo Visual

👤 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-ChamaControl.git

🛠 Pré-requisitos

Antes de rodar o projeto, instale as seguintes ferramentas:

• GNU Make 4.4 ou superior
• Python 3.10.12 e Pip 22.0.2 ou superior

⚙️ 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

Story Map

• Para acessar o Story Map, clique aqui.

Arquitetura

• Visualize o diagrama de arquitetura do projeto, clique aqui.

Protótipo Visual

• Para visualizar o protótipo do projeto, clique aqui.