diff --git a/gitpage/docs/arquitetura.md b/gitpage/docs/arquitetura.md
new file mode 100644
index 0000000..5b5bb45
--- /dev/null
+++ b/gitpage/docs/arquitetura.md
@@ -0,0 +1,13 @@
+# Arquitetura
+
+Esta arquitetura descreve um fluxo de dados composto por cinco componentes principais:
+
+1. **DataClass**: Responsável por iniciar o processo, utilizando o método `fetchData()` para capturar dados.
+2. **WebScrap**: Um módulo de raspagem web que coleta informações usando o método `scrape()` e contém a lógica para interagir com fontes externas.
+3. **API**: Atua como intermediária, fornecendo os dados através do método `getData()`, possibilitando o acesso de forma padronizada.
+4. **RegexReader**: Processa os dados recebidos por meio do método `process(data)` para organizar ou extrair informações relevantes.
+5. **FrontEnd**: Recebe os dados processados e os apresenta ao usuário final com o método `displayData(data)`.
+
+O fluxo segue uma sequência linear, com cada componente desempenhando um papel específico para transformar dados brutos em informações utilizáveis no front-end.
+
+
\ No newline at end of file
diff --git a/gitpage/docs/config.md b/gitpage/docs/config.md
index 7f9ceda..fc2250b 100644
--- a/gitpage/docs/config.md
+++ b/gitpage/docs/config.md
@@ -1,27 +1,30 @@
-## Configuração de ambiente
+## Linguagem e bibliotecas utilizadas 🦾
+- [Python 3.12](https://www.python.org/downloads/)
-- Python 3.12
-
-* Clone o repositório deste projeto através da seguinte linha de código
-
-```bash
-git clone https://github.com/unb-mds/2024-2-Squad14.git
-```
-
-### Bibliotecas
-
-- Streamlit
-- Numpy
-- Matplotlib
+ **- - Bibliotecas - -**
+ - Streamlit
+ - Numpy
+ - Matplotlib
+ - BeautifulSoup
+ - Unidecode
+
+Com Python instalado, faça a instalação das bibliotecas com os seguintes comandos no terminal:
```bash
pip install streamlit
pip install numpy
pip install matplotlib
+pip install bs4
+pip install unidecode
```
-### Executando o programa
+## Execução 🖥️
+Clone o repositório deste projeto através da seguinte linha de código:
+```bash
+git clone https://github.com/unb-mds/2024-2-Squad14.git
+```
+Execute o programa com:
```bash
streamlit run gov_app.py
```
diff --git a/gitpage/docs/img_docs/img_arquitetura.png b/gitpage/docs/img_docs/img_arquitetura.png
new file mode 100644
index 0000000..780334c
Binary files /dev/null and b/gitpage/docs/img_docs/img_arquitetura.png differ
diff --git a/gitpage/docs/img_docs/storymap.png b/gitpage/docs/img_docs/storymap.png
new file mode 100644
index 0000000..eed3b7d
Binary files /dev/null and b/gitpage/docs/img_docs/storymap.png differ
diff --git a/gitpage/docs/storymap.md b/gitpage/docs/storymap.md
new file mode 100644
index 0000000..b117cf6
--- /dev/null
+++ b/gitpage/docs/storymap.md
@@ -0,0 +1,5 @@
+# StoryMap
+
+### Segue o StoryMap
+
+
\ No newline at end of file
diff --git a/gitpage/docs/tecnology.md b/gitpage/docs/tecnology.md
index 4d05bb1..e69d589 100644
--- a/gitpage/docs/tecnology.md
+++ b/gitpage/docs/tecnology.md
@@ -1,19 +1,23 @@
# Tecnologias Utilizadas no Projeto
## 💻 Back-end
-- **Python** - Linguagem principal para desenvolvimento do servidor.
+
+- **Python** - Linguagem principal para desenvolvimento do projeto.
- **Numpy** - Framework para lidar com arrays e outros dados.
- **Matplotlib** - Framework para visualização interativa de dados.
## 🎨 Front-end
+
- **Streamlit** - Estrutura e estilização das páginas web.
## 🔧 Ferramentas
+
- **Docker** - Contêinerização para garantir a consistência entre ambientes.
- **Git e GitHub** - Controle de versão do código.
- **VS Code** - Editor de código utilizado pela equipe.
## 📖 Documentação e Organização
+
- **Markdown** - Escrita de documentações e READMEs.
- **Teams** - Discussão em relação ao projeto e planejamento de sprints.
diff --git a/gitpage/mkdocs.yml b/gitpage/mkdocs.yml
index 7f35f79..f9caf9b 100644
--- a/gitpage/mkdocs.yml
+++ b/gitpage/mkdocs.yml
@@ -70,4 +70,5 @@ nav:
- Backlog: backlog.md
- Requisitos: requisitos.md
- Arquitetura: arquitetura.md
+ - Story Map: storymap.md
- Configuração/Execução: config.md
diff --git a/gitpage/site/404.html b/gitpage/site/404.html
index 2991df8..119f408 100644
--- a/gitpage/site/404.html
+++ b/gitpage/site/404.html
@@ -239,51 +239,18 @@
-
"Como [tipo de usuário], quero [ação/funcionalidade], para que [benefício/valor esperado]."
-
Exemplo de User Story (Derivada do Épico acima)
-
"Consulta de Editais de Licitação"
+
+
Critérios de aceitação
+
Como definir critérios de aceitação?
+
Clareza e especificidade: Os critérios devem ser objetivos e fáceis de entender.
+Orientados ao comportamento: Devem descrever o que o sistema deve fazer, não como deve ser implementado.
+Testáveis: Devem permitir a validação por meio de testes claros e repetíveis.
+
Estrutura comum para critérios de aceitação
+
Critérios de aceitação geralmente são escritos no formato Dado... Quando... Então, que segue a lógica:
-
Como empresário,
-
quero acessar e baixar os editais de licitação do município,
-
para que eu possa participar dos processos de contratação pública de forma informada.
+
Dado: o contexto inicial ou condição prévia.
+
Quando: o evento ou ação realizada pelo usuário.
+
Então: o resultado esperado ou comportamento do sistema.
-
Épicos e User Story
-
-
-
-
Épico
-
História de Usuário
-
Prioridade
-
-
-
-
-
Visualização Gráfica dos Dados
-
Como cliente, eu quero visualizar os dados de uma forma mais amigável e correta. Para definir melhor a minha opinião sobre determinado dado.
-
-
-
-
-
Filtragem dos Dados
-
Como cidadão, eu quero filtrar os dados sobre os quais eu tenho interresse e sem distrações. Para facilitar o acesso aos meus interresses.
-
-
-
-
-
Comparação de Dados
-
Como usuário, eu quero a possibilidade da comparação dos dados de difentes datas. Para que seja possível uma análise de eficiência governamental durante os anos.
-
-
-
-
-
Exportação de Dados
-
Como cidadão interressado, quero exportar os dados sobre o município em formato CSV. Para realizar análises detalhadas e cruzar informações com outras bases de dados.
-
-
-
-
-
+
+
Épicos e User Story e seus Critérios de Aceitação
+
Critérios de Aceitação para as Histórias de Usuário
+
+
História 1: Visualização Gráfica dos Dados
+
"Como cliente, eu quero visualizar os dados de uma forma mais amigável e correta, para definir melhor a minha opinião sobre determinado dado."
+
Critérios de Aceitação:
+
+
Dado que o cliente acesse a página de visualização de dados, quando os dados forem carregados, então eles devem ser exibidos em gráficos interativos e claros (ex.: gráficos de barras, linhas, ou pizza).
+
Dado que o cliente interaja com o gráfico, quando ele passar o mouse sobre um ponto ou barra, então deve aparecer uma descrição detalhada (ex.: valores exatos e datas).
+
Dado que os dados exibidos sejam grandes ou complexos, quando o cliente quiser ver mais detalhes, então deve haver uma opção de zoom ou foco em um período específico.
+
+
+
História 2: Filtragem dos Dados
+
"Como cidadão, eu quero filtrar os dados sobre os quais eu tenho interesse e sem distrações, para facilitar o acesso aos meus interesses."
+
Critérios de Aceitação:
+
+
Dado que o cidadão esteja na interface de visualização de dados, quando ele selecionar um filtro (ex.: ano, categoria, município), então os dados exibidos devem ser atualizados de acordo com os critérios escolhidos.
+
Dado que o cidadão queira aplicar múltiplos filtros, quando ele escolher mais de um critério, então os dados devem refletir a interseção das condições.
+
Dado que nenhum filtro seja selecionado, quando o cidadão acessar a página, então os dados devem ser exibidos de forma geral e sem filtros aplicados.
+
Dado que o filtro aplicado não retorne resultados, quando o cidadão finalizar a seleção, então uma mensagem amigável deve informar que "não há dados correspondentes".
+
+
+
História 3: Comparação de Dados
+
"Como usuário, eu quero a possibilidade de comparar os dados de diferentes datas, para que seja possível uma análise de eficiência governamental durante os anos."
+
Critérios de Aceitação:
+
+
Dado que o usuário esteja na interface de comparação, quando ele selecionar duas ou mais datas ou períodos, então os dados correspondentes devem ser exibidos lado a lado ou sobrepostos no mesmo gráfico.
+
Dado que os dados de diferentes períodos sejam exibidos, quando o usuário clicar em uma linha ou barra do gráfico, então informações detalhadas (ex.: valor exato e data) devem ser mostradas para cada período selecionado.
+
Dado que o usuário deseje alterar os períodos comparados, quando ele ajustar a seleção, então os gráficos devem ser atualizados automaticamente.
+
Dado que os períodos selecionados não possuam dados, quando o usuário concluir a seleção, então uma mensagem deve informar que "não há dados disponíveis para as datas escolhidas".
+
+
+
História 4: Exportação de Dados
+
"Como cidadão interessado, quero exportar os dados sobre o município em formato CSV, para realizar análises detalhadas e cruzar informações com outras bases de dados."
+
Critérios de Aceitação:
+
+
Dado que o cidadão esteja visualizando os dados filtrados, quando ele clicar no botão de exportação, então um arquivo no formato CSV contendo os dados visíveis deve ser baixado.
+
Dado que o arquivo CSV seja gerado, quando o cidadão abrir o arquivo, então os dados devem estar organizados em colunas com cabeçalhos claros e consistentes.
+
Dado que o cidadão não tenha selecionado filtros, quando ele clicar no botão de exportação, então o CSV deve conter todos os dados disponíveis.
+
Dado que ocorra algum erro na exportação, quando o cidadão tentar realizar o download, então uma mensagem de erro deve ser exibida com instruções para tentar novamente.
Criar um painel de transparência municipal acessível e intuitivo que permita aos cidadãos monitorar e entender facilmente como os recursos públicos estão sendo utilizados, promovendo a participação cidadã e a confiança na administração pública.
+
Público-Alvo
+
Todos os cidadãos do município, incluindo:
+
+
Residentes
+
Jornalistas
+
Pesquisadores
+
Autoridades públicas
+
+
Com ênfase em ser acessível a usuários com diferentes níveis de habilidades tecnológicas.
+
Diferenciação
+
+
Oferecer uma interface amigável.
+
Integrar informações municipais de forma transparente e compreensível.
+
Utilizar visualizações de dados atraentes e interativas para facilitar a compreensão e a análise.
+
+
Benefícios Principais
+
+
+
Acesso Rápido e Fácil
+ Os cidadãos poderão acessar informações sobre despesas, receitas e projetos em andamento de forma clara e detalhada.
+
+
+
Transparência e Confiança
+ Aumentará a transparência governamental e fortalecerá a confiança da população na administração pública.
+
+
+
Engajamento Cidadão
+ Facilitará a participação ativa dos cidadãos nos assuntos municipais.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/gitpage/site/requisitos/index.html b/gitpage/site/requisitos/index.html
index 22db7d6..b670162 100644
--- a/gitpage/site/requisitos/index.html
+++ b/gitpage/site/requisitos/index.html
@@ -247,53 +247,20 @@
-
-
+
+
+
+
+
+
+
+
+
+
diff --git a/gitpage/site/search/search_index.json b/gitpage/site/search/search_index.json
index 575165a..89bc6b8 100644
--- a/gitpage/site/search/search_index.json
+++ b/gitpage/site/search/search_index.json
@@ -1 +1 @@
-{"config":{"lang":["pt"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Painel de Transpar\u00eancia Municipal","text":"Este projeto envolve a mat\u00e9ria de M\u00e9todos de Desenvolvimento de Software e a sua ultiliza\u00e7\u00e3o pr\u00e1tica no desenvolvimento de sistemas. A aplica\u00e7\u00e3o visa oferecer \u00e0 popula\u00e7\u00e3o interressada, uma vis\u00e3o mais simplificada dos dados municipais."},{"location":"#nossa-equipe","title":"Nossa Equipe","text":""},{"location":"#colaboradores","title":"Colaboradores","text":"EduardoWaski RR2M4A marcomarquesdc AndreMeyerr lfelipebessa ArturDCR ribmarcos"},{"location":"backlog/","title":"Backlog","text":"
O backlog de um produto \u00e9 uma lista din\u00e2mica e priorizada de todas as funcionalidades, melhorias, corre\u00e7\u00f5es e tarefas necess\u00e1rias para desenvolver e evoluir um produto. Ele serve como a base para o planejamento e execu\u00e7\u00e3o das equipes de desenvolvimento. Cada item no backlog deve estar claro, ter valor para o usu\u00e1rio ou para o neg\u00f3cio e ser priorizado com base na import\u00e2ncia, impacto e viabilidade. O backlog geralmente \u00e9 continuamente atualizado.
"},{"location":"backlog/#o-que-e-um-epico-e-uma-user-story","title":"O que \u00e9 um \u00c9pico e uma User Story?","text":""},{"location":"backlog/#epico","title":"\u00c9pico","text":"
Um \u00e9pico \u00e9 uma grande unidade de trabalho ou um objetivo de alto n\u00edvel dentro de um projeto que, normalmente, \u00e9 muito amplo para ser conclu\u00eddo em um \u00fanico sprint. Ele representa uma necessidade ou funcionalidade ampla e, por isso, \u00e9 subdividido em user stories menores e mais espec\u00edficas.
"},{"location":"backlog/#exemplo-de-epico","title":"Exemplo de \u00c9pico","text":"
\"Transpar\u00eancia em Licita\u00e7\u00f5es e Contratos\" Descri\u00e7\u00e3o: Criar funcionalidades que permitam aos cidad\u00e3os e empresas acessarem informa\u00e7\u00f5es sobre processos de licita\u00e7\u00e3o, contratos e fornecedores do munic\u00edpio.
"},{"location":"backlog/#user-story-historia-de-usuario","title":"User Story (Hist\u00f3ria de Usu\u00e1rio)","text":"
Uma user story \u00e9 uma descri\u00e7\u00e3o curta e simples do que um usu\u00e1rio deseja realizar com o sistema, escrita do ponto de vista dele. Seu objetivo \u00e9 capturar o valor que uma funcionalidade espec\u00edfica oferece ao usu\u00e1rio. As hist\u00f3rias seguem, geralmente, o seguinte formato:
\"Como [tipo de usu\u00e1rio], quero [a\u00e7\u00e3o/funcionalidade], para que [benef\u00edcio/valor esperado].\"
"},{"location":"backlog/#exemplo-de-user-story-derivada-do-epico-acima","title":"Exemplo de User Story (Derivada do \u00c9pico acima)","text":"
\"Consulta de Editais de Licita\u00e7\u00e3o\"
Como empres\u00e1rio,
quero acessar e baixar os editais de licita\u00e7\u00e3o do munic\u00edpio,
para que eu possa participar dos processos de contrata\u00e7\u00e3o p\u00fablica de forma informada.
"},{"location":"backlog/#epicos-e-user-story","title":"\u00c9picos e User Story","text":"\u00c9pico Hist\u00f3ria de Usu\u00e1rio Prioridade Visualiza\u00e7\u00e3o Gr\u00e1fica dos Dados Como cliente, eu quero visualizar os dados de uma forma mais amig\u00e1vel e correta. Para definir melhor a minha opini\u00e3o sobre determinado dado. - Filtragem dos Dados Como cidad\u00e3o, eu quero\u00a0filtrar os dados sobre os quais eu tenho interresse e sem distra\u00e7\u00f5es. Para facilitar o acesso aos meus interresses. - Compara\u00e7\u00e3o de Dados Como usu\u00e1rio, eu quero a possibilidade da compara\u00e7\u00e3o dos dados de difentes datas. Para que seja poss\u00edvel uma an\u00e1lise de efici\u00eancia governamental durante os anos. - Exporta\u00e7\u00e3o de Dados Como cidad\u00e3o interressado, quero exportar os dados sobre o munic\u00edpio em formato CSV. Para realizar an\u00e1lises detalhadas e cruzar informa\u00e7\u00f5es com outras bases de dados. -"},{"location":"config/","title":"Configura\u00e7\u00e3o/Execu\u00e7\u00e3o","text":""},{"location":"config/#configuracao-de-ambiente","title":"Configura\u00e7\u00e3o de ambiente","text":"
Python 3.12
Clone o reposit\u00f3rio deste projeto atrav\u00e9s da seguinte linha de c\u00f3digo
"},{"location":"config/#executando-o-programa","title":"Executando o programa","text":"
streamlit run gov_app.py\n
"},{"location":"requisitos/","title":"\ud83d\udcdd Requisitos do Projeto","text":"
Bem-vindo \u00e0 p\u00e1gina de requisitos do projeto! Aqui voc\u00ea encontrar\u00e1 uma lista detalhada das funcionalidades esperadas e outras especifica\u00e7\u00f5es.
Este documento deve ser revisado regularmente para refletir mudan\u00e7as no escopo do projeto.
"},{"location":"tecnology/","title":"Tecnologias Utilizadas no Projeto","text":""},{"location":"tecnology/#back-end","title":"\ud83d\udcbb Back-end","text":"
Python - Linguagem principal para desenvolvimento do servidor.
Numpy - Framework para lidar com arrays e outros dados.
Matplotlib - Framework para visualiza\u00e7\u00e3o interativa de dados.
Docker - Cont\u00eaineriza\u00e7\u00e3o para garantir a consist\u00eancia entre ambientes.
Git e GitHub - Controle de vers\u00e3o do c\u00f3digo.
VS Code - Editor de c\u00f3digo utilizado pela equipe.
"},{"location":"tecnology/#documentacao-e-organizacao","title":"\ud83d\udcd6 Documenta\u00e7\u00e3o e Organiza\u00e7\u00e3o","text":"
Markdown - Escrita de documenta\u00e7\u00f5es e READMEs.
Teams - Discuss\u00e3o em rela\u00e7\u00e3o ao projeto e planejamento de sprints.
\ud83d\udca1 Observa\u00e7\u00e3o: Esta lista pode ser expandida ou adaptada conforme o crescimento do projeto ou as tecnologias utilizadas sejam alteradas.
"}]}
\ No newline at end of file
+{"config":{"lang":["pt"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Painel de Transpar\u00eancia Municipal","text":"Este projeto envolve a mat\u00e9ria de M\u00e9todos de Desenvolvimento de Software e a sua ultiliza\u00e7\u00e3o pr\u00e1tica no desenvolvimento de sistemas. A aplica\u00e7\u00e3o visa oferecer \u00e0 popula\u00e7\u00e3o interressada, uma vis\u00e3o mais simplificada dos dados municipais."},{"location":"#nossa-equipe","title":"Nossa Equipe","text":""},{"location":"#colaboradores","title":"Colaboradores","text":"EduardoWaski RR2M4A marcomarquesdc AndreMeyerr lfelipebessa ArturDCR ribmarcos"},{"location":"backlog/","title":"Backlog","text":"
O backlog de um produto \u00e9 uma lista din\u00e2mica e priorizada de todas as funcionalidades, melhorias, corre\u00e7\u00f5es e tarefas necess\u00e1rias para desenvolver e evoluir um produto. Ele serve como a base para o planejamento e execu\u00e7\u00e3o das equipes de desenvolvimento. Cada item no backlog deve estar claro, ter valor para o usu\u00e1rio ou para o neg\u00f3cio e ser priorizado com base na import\u00e2ncia, impacto e viabilidade. O backlog geralmente \u00e9 continuamente atualizado.
"},{"location":"backlog/#o-que-e-um-epico-e-uma-user-story","title":"O que \u00e9 um \u00c9pico e uma User Story?","text":""},{"location":"backlog/#epico","title":"\u00c9pico","text":"
Um \u00e9pico \u00e9 uma grande unidade de trabalho ou um objetivo de alto n\u00edvel dentro de um projeto que, normalmente, \u00e9 muito amplo para ser conclu\u00eddo em um \u00fanico sprint. Ele representa uma necessidade ou funcionalidade ampla e, por isso, \u00e9 subdividido em user stories menores e mais espec\u00edficas.
"},{"location":"backlog/#exemplo-de-epico","title":"Exemplo de \u00c9pico","text":"
\"Transpar\u00eancia em Licita\u00e7\u00f5es e Contratos\" Descri\u00e7\u00e3o: Criar funcionalidades que permitam aos cidad\u00e3os e empresas acessarem informa\u00e7\u00f5es sobre processos de licita\u00e7\u00e3o, contratos e fornecedores do munic\u00edpio.
"},{"location":"backlog/#user-story-historia-de-usuario","title":"User Story (Hist\u00f3ria de Usu\u00e1rio)","text":"
Uma user story \u00e9 uma descri\u00e7\u00e3o curta e simples do que um usu\u00e1rio deseja realizar com o sistema, escrita do ponto de vista dele. Seu objetivo \u00e9 capturar o valor que uma funcionalidade espec\u00edfica oferece ao usu\u00e1rio. As hist\u00f3rias seguem, geralmente, o seguinte formato:
\"Como [tipo de usu\u00e1rio], quero [a\u00e7\u00e3o/funcionalidade], para que [benef\u00edcio/valor esperado].\"
"},{"location":"backlog/#criterios-de-aceitacao","title":"Crit\u00e9rios de aceita\u00e7\u00e3o","text":""},{"location":"backlog/#como-definir-criterios-de-aceitacao","title":"Como definir crit\u00e9rios de aceita\u00e7\u00e3o?","text":"
Clareza e especificidade: Os crit\u00e9rios devem ser objetivos e f\u00e1ceis de entender. Orientados ao comportamento: Devem descrever o que o sistema deve fazer, n\u00e3o como deve ser implementado. Test\u00e1veis: Devem permitir a valida\u00e7\u00e3o por meio de testes claros e repet\u00edveis.
"},{"location":"backlog/#estrutura-comum-para-criterios-de-aceitacao","title":"Estrutura comum para crit\u00e9rios de aceita\u00e7\u00e3o","text":"
Crit\u00e9rios de aceita\u00e7\u00e3o geralmente s\u00e3o escritos no formato Dado... Quando... Ent\u00e3o, que segue a l\u00f3gica:
Dado: o contexto inicial ou condi\u00e7\u00e3o pr\u00e9via.
Quando: o evento ou a\u00e7\u00e3o realizada pelo usu\u00e1rio.
Ent\u00e3o: o resultado esperado ou comportamento do sistema.
"},{"location":"backlog/#epicos-e-user-story-e-seus-criterios-de-aceitacao","title":"\u00c9picos e User Story e seus Crit\u00e9rios de Aceita\u00e7\u00e3o","text":""},{"location":"backlog/#criterios-de-aceitacao-para-as-historias-de-usuario","title":"Crit\u00e9rios de Aceita\u00e7\u00e3o para as Hist\u00f3rias de Usu\u00e1rio","text":""},{"location":"backlog/#historia-1-visualizacao-grafica-dos-dados","title":"Hist\u00f3ria 1: Visualiza\u00e7\u00e3o Gr\u00e1fica dos Dados","text":"
\"Como cliente, eu quero visualizar os dados de uma forma mais amig\u00e1vel e correta, para definir melhor a minha opini\u00e3o sobre determinado dado.\"
Crit\u00e9rios de Aceita\u00e7\u00e3o:
Dado que o cliente acesse a p\u00e1gina de visualiza\u00e7\u00e3o de dados, quando os dados forem carregados, ent\u00e3o eles devem ser exibidos em gr\u00e1ficos interativos e claros (ex.: gr\u00e1ficos de barras, linhas, ou pizza).
Dado que o cliente interaja com o gr\u00e1fico, quando ele passar o mouse sobre um ponto ou barra, ent\u00e3o deve aparecer uma descri\u00e7\u00e3o detalhada (ex.: valores exatos e datas).
Dado que os dados exibidos sejam grandes ou complexos, quando o cliente quiser ver mais detalhes, ent\u00e3o deve haver uma op\u00e7\u00e3o de zoom ou foco em um per\u00edodo espec\u00edfico.
"},{"location":"backlog/#historia-2-filtragem-dos-dados","title":"Hist\u00f3ria 2: Filtragem dos Dados","text":"
\"Como cidad\u00e3o, eu quero filtrar os dados sobre os quais eu tenho interesse e sem distra\u00e7\u00f5es, para facilitar o acesso aos meus interesses.\"
Crit\u00e9rios de Aceita\u00e7\u00e3o:
Dado que o cidad\u00e3o esteja na interface de visualiza\u00e7\u00e3o de dados, quando ele selecionar um filtro (ex.: ano, categoria, munic\u00edpio), ent\u00e3o os dados exibidos devem ser atualizados de acordo com os crit\u00e9rios escolhidos.
Dado que o cidad\u00e3o queira aplicar m\u00faltiplos filtros, quando ele escolher mais de um crit\u00e9rio, ent\u00e3o os dados devem refletir a interse\u00e7\u00e3o das condi\u00e7\u00f5es.
Dado que nenhum filtro seja selecionado, quando o cidad\u00e3o acessar a p\u00e1gina, ent\u00e3o os dados devem ser exibidos de forma geral e sem filtros aplicados.
Dado que o filtro aplicado n\u00e3o retorne resultados, quando o cidad\u00e3o finalizar a sele\u00e7\u00e3o, ent\u00e3o uma mensagem amig\u00e1vel deve informar que \"n\u00e3o h\u00e1 dados correspondentes\".
"},{"location":"backlog/#historia-3-comparacao-de-dados","title":"Hist\u00f3ria 3: Compara\u00e7\u00e3o de Dados","text":"
\"Como usu\u00e1rio, eu quero a possibilidade de comparar os dados de diferentes datas, para que seja poss\u00edvel uma an\u00e1lise de efici\u00eancia governamental durante os anos.\"
Crit\u00e9rios de Aceita\u00e7\u00e3o:
Dado que o usu\u00e1rio esteja na interface de compara\u00e7\u00e3o, quando ele selecionar duas ou mais datas ou per\u00edodos, ent\u00e3o os dados correspondentes devem ser exibidos lado a lado ou sobrepostos no mesmo gr\u00e1fico.
Dado que os dados de diferentes per\u00edodos sejam exibidos, quando o usu\u00e1rio clicar em uma linha ou barra do gr\u00e1fico, ent\u00e3o informa\u00e7\u00f5es detalhadas (ex.: valor exato e data) devem ser mostradas para cada per\u00edodo selecionado.
Dado que o usu\u00e1rio deseje alterar os per\u00edodos comparados, quando ele ajustar a sele\u00e7\u00e3o, ent\u00e3o os gr\u00e1ficos devem ser atualizados automaticamente.
Dado que os per\u00edodos selecionados n\u00e3o possuam dados, quando o usu\u00e1rio concluir a sele\u00e7\u00e3o, ent\u00e3o uma mensagem deve informar que \"n\u00e3o h\u00e1 dados dispon\u00edveis para as datas escolhidas\".
"},{"location":"backlog/#historia-4-exportacao-de-dados","title":"Hist\u00f3ria 4: Exporta\u00e7\u00e3o de Dados","text":"
\"Como cidad\u00e3o interessado, quero exportar os dados sobre o munic\u00edpio em formato CSV, para realizar an\u00e1lises detalhadas e cruzar informa\u00e7\u00f5es com outras bases de dados.\"
Crit\u00e9rios de Aceita\u00e7\u00e3o:
Dado que o cidad\u00e3o esteja visualizando os dados filtrados, quando ele clicar no bot\u00e3o de exporta\u00e7\u00e3o, ent\u00e3o um arquivo no formato CSV contendo os dados vis\u00edveis deve ser baixado.
Dado que o arquivo CSV seja gerado, quando o cidad\u00e3o abrir o arquivo, ent\u00e3o os dados devem estar organizados em colunas com cabe\u00e7alhos claros e consistentes.
Dado que o cidad\u00e3o n\u00e3o tenha selecionado filtros, quando ele clicar no bot\u00e3o de exporta\u00e7\u00e3o, ent\u00e3o o CSV deve conter todos os dados dispon\u00edveis.
Dado que ocorra algum erro na exporta\u00e7\u00e3o, quando o cidad\u00e3o tentar realizar o download, ent\u00e3o uma mensagem de erro deve ser exibida com instru\u00e7\u00f5es para tentar novamente.
"},{"location":"config/","title":"Configura\u00e7\u00e3o/Execu\u00e7\u00e3o","text":""},{"location":"config/#configuracao-de-ambiente","title":"Configura\u00e7\u00e3o de ambiente","text":"
Python 3.12
Clone o reposit\u00f3rio deste projeto atrav\u00e9s da seguinte linha de c\u00f3digo
"},{"location":"config/#executando-o-programa","title":"Executando o programa","text":"
streamlit run gov_app.py\n
"},{"location":"productview/","title":"Vis\u00e3o do Produto","text":""},{"location":"productview/#objetivo","title":"Objetivo","text":"
Criar um painel de transpar\u00eancia municipal acess\u00edvel e intuitivo que permita aos cidad\u00e3os monitorar e entender facilmente como os recursos p\u00fablicos est\u00e3o sendo utilizados, promovendo a participa\u00e7\u00e3o cidad\u00e3 e a confian\u00e7a na administra\u00e7\u00e3o p\u00fablica.
Acesso R\u00e1pido e F\u00e1cil Os cidad\u00e3os poder\u00e3o acessar informa\u00e7\u00f5es sobre despesas, receitas e projetos em andamento de forma clara e detalhada.
Transpar\u00eancia e Confian\u00e7a Aumentar\u00e1 a transpar\u00eancia governamental e fortalecer\u00e1 a confian\u00e7a da popula\u00e7\u00e3o na administra\u00e7\u00e3o p\u00fablica.
Engajamento Cidad\u00e3o Facilitar\u00e1 a participa\u00e7\u00e3o ativa dos cidad\u00e3os nos assuntos municipais.
"},{"location":"requisitos/","title":"\ud83d\udcdd Requisitos do Projeto","text":"
Bem-vindo \u00e0 p\u00e1gina de requisitos do projeto! Aqui voc\u00ea encontrar\u00e1 uma lista detalhada das funcionalidades esperadas e outras especifica\u00e7\u00f5es.
Este documento deve ser revisado regularmente para refletir mudan\u00e7as no escopo do projeto.
"},{"location":"sprints/","title":"Planejamento do Projeto","text":""},{"location":"sprints/#sprint-0-preparacao-inicial","title":"Sprint 0: Prepara\u00e7\u00e3o Inicial","text":"
Defini\u00e7\u00e3o do grupo Identificar os membros da equipe e estabelecer o comprometimento de todos.
Verifica\u00e7\u00e3o de fun\u00e7\u00f5es espec\u00edficas de cada membro do grupo Delega\u00e7\u00e3o de responsabilidades e pap\u00e9is com base nas habilidades individuais.
"},{"location":"sprints/#sprint-1-estudos-e-organizacao","title":"Sprint 1: Estudos e Organiza\u00e7\u00e3o","text":""},{"location":"sprints/#estudos-dos-seguintes-topicos-e-abertura-de-issues-associadas","title":"Estudos dos seguintes t\u00f3picos e abertura de issues associadas","text":"
Cria\u00e7\u00e3o de templates para documenta\u00e7\u00f5es \u2013 Respons\u00e1vel: Jos\u00e9
"},{"location":"sprints/#sprint-2-definicao-do-escopo","title":"Sprint 2: Defini\u00e7\u00e3o do Escopo","text":"
Montagem do escopo do produto Utilizar a ferramenta Mural para realizar uma Lean Inception e consolidar as principais funcionalidades e requisitos.
"},{"location":"sprints/#sprint-3-definicao-da-arquitetura","title":"Sprint 3: Defini\u00e7\u00e3o da Arquitetura","text":"
Planejamento t\u00e9cnico inicial Escolha das tecnologias a serem utilizadas. Rascunho da arquitetura do software. Elabora\u00e7\u00e3o de pseudoc\u00f3digos iniciais para guiar o desenvolvimento.
"},{"location":"sprints/#sprint-4-implementacao-e-revisao","title":"Sprint 4: Implementa\u00e7\u00e3o e Revis\u00e3o","text":"
Aplica\u00e7\u00e3o pr\u00e1tica dos estudos Desenvolvimento de c\u00f3digos oficiais com base nos t\u00f3picos estudados.
Revis\u00e3o t\u00e9cnica Verifica\u00e7\u00e3o do funcionamento correto de APIs e web scraping.
"},{"location":"sprints/#sprint-5-preparacao-para-a-release-1","title":"Sprint 5: Prepara\u00e7\u00e3o para a Release 1","text":"
Avalia\u00e7\u00e3o do produto Alinhar expectativas e tarefas com toda a equipe presente.
Planejamento da entrega Organizar os detalhes finais para a primeira release.
"},{"location":"tecnology/","title":"Tecnologias Utilizadas no Projeto","text":""},{"location":"tecnology/#back-end","title":"\ud83d\udcbb Back-end","text":"
Python - Linguagem principal para desenvolvimento do servidor.
Numpy - Framework para lidar com arrays e outros dados.
Matplotlib - Framework para visualiza\u00e7\u00e3o interativa de dados.
Docker - Cont\u00eaineriza\u00e7\u00e3o para garantir a consist\u00eancia entre ambientes.
Git e GitHub - Controle de vers\u00e3o do c\u00f3digo.
VS Code - Editor de c\u00f3digo utilizado pela equipe.
"},{"location":"tecnology/#documentacao-e-organizacao","title":"\ud83d\udcd6 Documenta\u00e7\u00e3o e Organiza\u00e7\u00e3o","text":"
Markdown - Escrita de documenta\u00e7\u00f5es e READMEs.
Teams - Discuss\u00e3o em rela\u00e7\u00e3o ao projeto e planejamento de sprints.
\ud83d\udca1 Observa\u00e7\u00e3o: Esta lista pode ser expandida ou adaptada conforme o crescimento do projeto ou as tecnologias utilizadas sejam alteradas.
"}]}
\ No newline at end of file
diff --git a/gitpage/site/sitemap.xml.gz b/gitpage/site/sitemap.xml.gz
index 0db6900..e0910e0 100644
Binary files a/gitpage/site/sitemap.xml.gz and b/gitpage/site/sitemap.xml.gz differ
diff --git a/gitpage/site/sprints/index.html b/gitpage/site/sprints/index.html
index e326e51..295f55c 100644
--- a/gitpage/site/sprints/index.html
+++ b/gitpage/site/sprints/index.html
@@ -12,7 +12,7 @@
-
+
@@ -71,6 +71,11 @@
Definição do grupo
+ Identificar os membros da equipe e estabelecer o comprometimento de todos.
+
Verificação de funções específicas de cada membro do grupo
+ Delegação de responsabilidades e papéis com base nas habilidades individuais.
+
+
+
Sprint 1: Estudos e Organização
+
Estudos dos seguintes tópicos e abertura de issues associadas
+
+
Artefatos, Rituais, Papéis – Responsável: Marcos
+
Planning Poker – Responsável: Marco
+
História de Usuário – Responsável: Eduardo
+
Critérios de Aceitação – Responsável: Arthur
+
Burndown – Responsável: Luiz
+
Dívida Técnica – Responsável: André
+
+
Ações Adicionais
+
+
Criação de templates para documentações – Responsável: José
+
+
+
Sprint 2: Definição do Escopo
+
+
Montagem do escopo do produto
+ Utilizar a ferramenta Mural para realizar uma Lean Inception e consolidar as principais funcionalidades e requisitos.
+
+
+
Sprint 3: Definição da Arquitetura
+
+
Planejamento técnico inicial
+ Escolha das tecnologias a serem utilizadas.
+ Rascunho da arquitetura do software.
+ Elaboração de pseudocódigos iniciais para guiar o desenvolvimento.
+
+
+
Sprint 4: Implementação e Revisão
+
+
Aplicação prática dos estudos
+ Desenvolvimento de códigos oficiais com base nos tópicos estudados.
+
Revisão técnica
+ Verificação do funcionamento correto de APIs e web scraping.
+
+
+
Sprint 5: Preparação para a Release 1
+
+
Avaliação do produto
+ Alinhar expectativas e tarefas com toda a equipe presente.
+
Planejamento da entrega
+ Organizar os detalhes finais para a primeira release.
\ No newline at end of file
diff --git a/gitpage/docs/config.md b/gitpage/docs/config.md
index 7f9ceda..fc2250b 100644
--- a/gitpage/docs/config.md
+++ b/gitpage/docs/config.md
@@ -1,27 +1,30 @@
-## Configuração de ambiente
+## Linguagem e bibliotecas utilizadas 🦾
+- [Python 3.12](https://www.python.org/downloads/)
-- Python 3.12
-
-* Clone o repositório deste projeto através da seguinte linha de código
-
-```bash
-git clone https://github.com/unb-mds/2024-2-Squad14.git
-```
-
-### Bibliotecas
-
-- Streamlit
-- Numpy
-- Matplotlib
+ **- - Bibliotecas - -**
+ - Streamlit
+ - Numpy
+ - Matplotlib
+ - BeautifulSoup
+ - Unidecode
+
+Com Python instalado, faça a instalação das bibliotecas com os seguintes comandos no terminal:
```bash
pip install streamlit
pip install numpy
pip install matplotlib
+pip install bs4
+pip install unidecode
```
-### Executando o programa
+## Execução 🖥️
+Clone o repositório deste projeto através da seguinte linha de código:
+```bash
+git clone https://github.com/unb-mds/2024-2-Squad14.git
+```
+Execute o programa com:
```bash
streamlit run gov_app.py
```
diff --git a/gitpage/docs/img_docs/img_arquitetura.png b/gitpage/docs/img_docs/img_arquitetura.png
new file mode 100644
index 0000000..780334c
Binary files /dev/null and b/gitpage/docs/img_docs/img_arquitetura.png differ
diff --git a/gitpage/docs/img_docs/storymap.png b/gitpage/docs/img_docs/storymap.png
new file mode 100644
index 0000000..eed3b7d
Binary files /dev/null and b/gitpage/docs/img_docs/storymap.png differ
diff --git a/gitpage/docs/storymap.md b/gitpage/docs/storymap.md
new file mode 100644
index 0000000..b117cf6
--- /dev/null
+++ b/gitpage/docs/storymap.md
@@ -0,0 +1,5 @@
+# StoryMap
+
+### Segue o StoryMap
+
+
\ No newline at end of file
diff --git a/gitpage/docs/tecnology.md b/gitpage/docs/tecnology.md
index 4d05bb1..e69d589 100644
--- a/gitpage/docs/tecnology.md
+++ b/gitpage/docs/tecnology.md
@@ -1,19 +1,23 @@
# Tecnologias Utilizadas no Projeto
## 💻 Back-end
-- **Python** - Linguagem principal para desenvolvimento do servidor.
+
+- **Python** - Linguagem principal para desenvolvimento do projeto.
- **Numpy** - Framework para lidar com arrays e outros dados.
- **Matplotlib** - Framework para visualização interativa de dados.
## 🎨 Front-end
+
- **Streamlit** - Estrutura e estilização das páginas web.
## 🔧 Ferramentas
+
- **Docker** - Contêinerização para garantir a consistência entre ambientes.
- **Git e GitHub** - Controle de versão do código.
- **VS Code** - Editor de código utilizado pela equipe.
## 📖 Documentação e Organização
+
- **Markdown** - Escrita de documentações e READMEs.
- **Teams** - Discussão em relação ao projeto e planejamento de sprints.
diff --git a/gitpage/mkdocs.yml b/gitpage/mkdocs.yml
index 7f35f79..f9caf9b 100644
--- a/gitpage/mkdocs.yml
+++ b/gitpage/mkdocs.yml
@@ -70,4 +70,5 @@ nav:
- Backlog: backlog.md
- Requisitos: requisitos.md
- Arquitetura: arquitetura.md
+ - Story Map: storymap.md
- Configuração/Execução: config.md
diff --git a/gitpage/site/404.html b/gitpage/site/404.html
index 2991df8..119f408 100644
--- a/gitpage/site/404.html
+++ b/gitpage/site/404.html
@@ -239,51 +239,18 @@
-