From c11938aa05cad65c961b252ff5d8b51f39c4305a Mon Sep 17 00:00:00 2001 From: Gabriel Date: Wed, 6 Nov 2024 17:39:44 -0300 Subject: [PATCH] =?UTF-8?q?Atualiza=C3=A7=C3=A3o=20da=20documenta=C3=A7?= =?UTF-8?q?=C3=A3o=20mkdocs?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 20 ++++++++----- docs/about.md | 63 ++++++++++++++++++++++++++++++++++++++++ docs/index.md | 34 +++++++++++++++++----- docs/integrantes.md | 12 -------- docs/sprints/sprint-0.md | 61 ++++++++++++++++++++++++++++++++++++++ mkdocs.yml | 54 ++++++++++++++++++++++++++++++---- 6 files changed, 212 insertions(+), 32 deletions(-) create mode 100644 docs/about.md delete mode 100644 docs/integrantes.md create mode 100644 docs/sprints/sprint-0.md diff --git a/README.md b/README.md index ae102c25..dc3fb012 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 diff --git a/docs/about.md b/docs/about.md new file mode 100644 index 00000000..304c85f1 --- /dev/null +++ b/docs/about.md @@ -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. + + +--- + +
+ + + + + + + + + + + +
+ + +
Gabriel Lima
+ + 		+ + +
Leo Lima
+ + 		+ + +
Vitor Bessa
+ + 		+ + +
Mateus Bastos
+ + 		+ + +
Fernanda Vaz
+ + 		+ + +
Angelica Campos
+ +
+
\ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 86b3b16b..ab66e2cc 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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. diff --git a/docs/integrantes.md b/docs/integrantes.md deleted file mode 100644 index d14f11e7..00000000 --- a/docs/integrantes.md +++ /dev/null @@ -1,12 +0,0 @@ -# Integrantes do Urbanize - -texto sobres os integrantes - -## Lista de Integrantes - -- [Gabriel Lima](https://github.com/gabriel-lima258) – Back-end -- [Leonardo lima](https://github.com/leozinlima) – Front-end -- [Fernanda Vaz](https://github.com/Fernandavazgit1) – Front-end -- [Angélica Campos](https://github.com/angelicaccampo) – Front-end -- [Mateus Bastos](https://github.com/MateuSansete) – Back-end -- [Vitor Bessa](https://github.com/Bessazs) – DevOps e Requisitos diff --git a/docs/sprints/sprint-0.md b/docs/sprints/sprint-0.md new file mode 100644 index 00000000..916ed0ba --- /dev/null +++ b/docs/sprints/sprint-0.md @@ -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. + +--- \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 2161b3c9..4aad45e4 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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 \ No newline at end of file + 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 +