Skip to content

Commit

Permalink
Atualização da documentação mkdocs
Browse files Browse the repository at this point in the history
  • Loading branch information
gabriel-lima258 committed Nov 6, 2024
1 parent 98fd63d commit c11938a
Show file tree
Hide file tree
Showing 6 changed files with 212 additions and 32 deletions.
20 changes: 12 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
# 🏗️ Urbanize

## Sumário
- [📝 Descrição do Projeto](#-descrição-do-projeto)
- [✅ Funcionalidades](#-funcionalidades)
- [📱 Tecnologias](#-tecnologias)
- [🧑‍🏭 Executando a aplicação](#-executando-a-aplicação)
- [🏗️ Urbanize](#️-urbanize)
- [Sumário](#sumário)
- [📝 Descrição do Projeto](#-descrição-do-projeto)
- [✅ Funcionalidades](#-funcionalidades)
- [📱 Tecnologias](#-tecnologias)
- [🧑‍🏭 Executando a aplicação](#-executando-a-aplicação)
- [📋 Pré-requisitos](#-pré-requisitos)
- [💻 Ambiente](#-ambiente)
- [📚 Documentação](#-documentação)
- [👥 Colaboradores](#-colaboradores)
- [💻 Ambiente](#-ambiente)
- [📚 Documentação](#-documentação)
- [👥 Colaboradores](#-colaboradores)


## 📝 Descrição do Projeto
Expand All @@ -23,9 +25,11 @@ Este projeto realiza o mapeamento de obras e serviços, proporcionando uma visã
- Visualização de dados e informações sobre as obras

## 📱 Tecnologias
- NodeJs
- Express.js
- Docker
- Python
- TypeScript
- Tailwind

## 🧑‍🏭 Executando a aplicação

Expand Down
63 changes: 63 additions & 0 deletions docs/about.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
# Sobre

## Sobre os integrantes

**Gabriel:** estudante back-end e front-end.

**Leo Lima:** estudante e entusiasta de tecnologias front-end.

**Vitor Bessa:** estudante de Engenharia de Software e apaixonado por programação.

**Mateus Bastos:** estudante e entusiasta de Engenharia de Software.

**Fernanda Vaz:** estudante e entusiasta de Engenharia de Software.

**Angelica Campos:** estudante e desenvolvedora entusiasta do universo JavaScript.


---

<center>
<table style="margin-left: auto; margin-right: auto;">
<tr>
<td align="center">
<a href="https://github.com/gabriel-lima258">
<img style="border-radius: 50%;" src="https://avatars.githubusercontent.com/u/116119327?v=4" width="150px;"/>
<h5 class="text-center">Gabriel Lima</h5>
</a>
</td>
<td align="center">
<a href="https://github.com/leozinlima">
<img style="border-radius: 50%;" src="https://avatars.githubusercontent.com/u/105813929?v=4" width="150px;"/>
<h5 class="text-center">Leo Lima</h5>
</a>
</td>
<td align="center">
<a href="https://github.com/Bessazs">
<img style="border-radius: 50%;" src="https://avatars.githubusercontent.com/u/118318004?v=4" width="150px;"/>
<h5 class="text-center">Vitor Bessa</h5>
</a>
</td>
</td>
<td align="center">
<a href="https://github.com/MateuSansete">
<img style="border-radius: 50%;" src="https://avatars.githubusercontent.com/u/164573233?v=4" width="150px;"/>
<h5 class="text-center">Mateus Bastos</h5>
</a>
</td>
<td align="center">
<a href="https://github.com/Fernandavazgit1">
<img style="border-radius: 50%;" src="https://avatars.githubusercontent.com/u/144569110?v=4" width="150px;"/>
<h5 class="text-center">Fernanda Vaz</h5>
</a>
</td>
<td align="center">
<a href="https://github.com/angelicaccampos">
<img style="border-radius: 50%;" src="https://avatars.githubusercontent.com/u/82877749?v=4" width="150px;"/>
<h5 class="text-center">Angelica Campos</h5>
</a>
</td>
</table>
</center>
34 changes: 27 additions & 7 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,33 @@
# Urbanize: Mapeamento de obras e serviços
# Urbanize

Bem-vindo à Wiki do Urbanize
## Sobre o Projeto
Bem-vindo ao **Urbanize**, um projeto desenvolvido na disciplina de Métodos de Desenvolvimento de Software (MDS) do curso de Engenharia de Software da Universidade de Brasília (UnB). Este projeto visa em fazer o mapeamento e consolidação de dados sobre obras e serviços públicos do DF.

Urbanize é uma plataforma intuitiva e moderna para o mapeamento e acompanhamento de obras públicas, permitindo que cidadãos, gestores e equipes técnicas visualizem, monitorem e planejem o desenvolvimento urbano em tempo real
---

## Benefícios e Recursos
## Motivação

Escrever sobre os benefícios e funcionalidades do projeto
O projeto Urbanize nasce da necessidade de promover transparência e acessibilidade à informação sobre obras e serviços públicos do Distrito Federal (DF). Ao centralizar e consolidar dados sobre intervenções urbanas, buscamos fornecer à população e aos gestores públicos uma visão clara e atualizada das iniciativas em andamento, facilitando o acompanhamento de prazos, etapas de execução e impacto das obras.

---

## Objetivo

O **Urbanize** tem como objetivos principais:

- **Desenvolver um mapa interativo de obras públicas:** Criar uma interface visual que permita aos usuários explorar de forma intuitiva e dinâmica as diversas obras e serviços públicos em andamento no
- **Implementar ferramentas de pesquisa e filtragem avançadas:** Permitir que os usuários busquem e filtrem obras públicas no mapa com base em critérios específicos, como o órgão solicitante, status da obra, localidade e data de início, facilitando o acesso rápido a informações relevantes.
- **Oferecer visualização detalhada de dados e informações sobre as obras:** Exibir dados detalhados de cada obra, como cronograma, orçamento, responsáveis e impacto esperado, promovendo a transparência e o entendimento completo de cada projeto urbano.

---

## Principais Funcionalidades

- **Coleta e Atualização de Dados:** Extração de informações do Censo de Obras usando técnicas de web scraping.
- **Processamento de Dados:** Realização de análises descritivas automatizadas para processar e interpretar os dados.
- **Confiabilidade dos Dados:** Implementação de validações e tratamento de erros para garantir a precisão e integridade dos dados coletados.
- **Visualização de Dados:** Desenvolvimento de uma interface intuitiva e responsiva para a apresentação mapeada, facilitando a análise e interpretação.
- **Pesquisa Avançada:** Funcionalidades de busca e filtragem detalhada por início e término, gastos e andamento da obra, permitindo consultas específicas e personalizadas.

---

Explore nossa Wiki para obter mais informações sobre como utilizar todas essas funcionalidades em seu benefício.

12 changes: 0 additions & 12 deletions docs/integrantes.md

This file was deleted.

61 changes: 61 additions & 0 deletions docs/sprints/sprint-0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# Sprint 0

Período: 05/11/2024 a 012/04/2024

---

## Descrição

Nesta Sprint, o grupo determinou que as reuniões semanais acontecerão às sábado, às 10:00, remotamente, adicionalmente terá dailys no teams às 21:00. foi designado o "Coelho da Semana", encarregado de estudar o git, que ainda nessa sprint, fez uma reunião de nivelamento sobre o tema. Por fim, foram estabelecidos o tema da aplicação, os requisitos iniciais e os objetivos a serem alcançados, além de uma breve descrição das tecnologias a serem utilizadas.

---

## Objetivos

- Definição dos horários das reuniões semanais
- Estudar Git e GitHub
- Estudar Scrum
- Definir tema da aplicação
- Definir requisitos iniciais
- Definir tecnologias utilizadas
- Estudar Docker

---

## Reuniões

### Reunião 1

Data: 05/11/2024

Local: Teams

**Ata:**

Nessa reunião, o time definiu o tema e idealizou as tecnologias a serem utilizadas, bem como a estrutura do projeto. Foi definido também o coelho da semana:

- Git, GitHub ([Gabriel](https://github.com/gabriel-lima258))

*Aplicação web:*
- Frontend: Next.js (Typescript e Tailwind)
- Backend: Express.js



### Reunião 2

Data: 10/11/2024

Local: Teams

**Ata:**

Na segunda reunião, o time definiu que as reuniões semanais serão realizadas aos sábados de forma remota às 10 horas. Ademais, foi feito um nivelamento sobre github e git pelo coelho.

---

## Finalização

O time conseguiu realizar todos os objetivos propostos para a Sprint.

---
54 changes: 49 additions & 5 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,53 @@
site_name: Documentação Urbanize

nav:
- Início: "index.md"
- Sobre: ""
- Integrantes: "integrantes.md"
- Documentação: ""
- Início: index.md
- Sprints:
- Sprint 0: sprints/sprint-0.md
- Projeto:
- Personas: project/personas.md
- Story Map: project/storymap.md
- Requisitos: project/requirements.md
- EAP: project/eap.md
- API: project/servicos.md
- Arquitetura e Tecnologias: project/arquitetura.md
- Protótipo: project/prototipo.md
- Sobre: about.md

theme:
name: material
font:
text: Roboto
language: pt-BR
name: material
features:
- navigation.tabs
- content.code.copy
- navigation.instant
- navigation.instant.progress
- toc.integrate
- navigation.top
- content.tabs.link

palette:

# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: green
accent: light green
toggle:
icon: material/brightness-7
name: Switch to dark mode

# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: green
accent: light green
toggle:
icon: material/brightness-4
name: Switch to light mode

icon:
repo: fontawesome/brands/git-alt

0 comments on commit c11938a

Please sign in to comment.