Merge branch 'main' of github.com:unb-mds/2024-1-Squad07

unb-mds · Jul 17, 2024 · ef1db46 · ef1db46
2 parents e052f49 + 4eff963
commit ef1db46
Show file tree

Hide file tree

Showing 46 changed files with 7,703 additions and 101 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,2 +1,2 @@
-venv
-webscrapy
+node_modules
+venv
diff --git a/README.md b/README.md
@@ -1,4 +1,7 @@
 # 2024-1-Minas de cultura
+<div align="center">
+    <img src="https://github.com/unb-mds/2024-1-MinasDeCultura/blob/main/docs/assets/images/logo_vermelha.png?raw=true" style="width:20vw"/>
+</div>
 
 ## Projeto de Análise de Licitações Culturais
 
@@ -11,7 +14,9 @@ Através desta aplicação, buscamos oferecer uma maneira mais transparente e ac
     - [📝 Sumário](#-sumário)
     - [⚙️ Funcionalidades](#%EF%B8%8F-funcionalidades-previstas)
     - [💻 Tecnologias](#-tecnologias)
-    - [📚 Documentação](#-documentação)
+    - [🤖 Prototipação e Identidade Visual](#-prototipação-e-identidade-visual)
+    - [Protótipo de utilização da API do Querido Diário](#-Protótipo-de-utilização-da-API-do-Querido-Diário)
+    - [Como testar o protótipo?](#-Como-testar-o-protótipo?)
     - [👥 Desenvolvedores](#-desenvolvedores)
     - [🗒 Story Map](#-story-map)
     - [🛠 Arquitetura](#-arquitetura)
@@ -45,6 +50,68 @@ Através desta aplicação, buscamos oferecer uma maneira mais transparente e ac
 <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript" target="_blank"><img src="https://img.shields.io/badge/JavaScript-purple?style=for-the-badge&logo=javascript" alt="JavaScript"></a>
 <a href="https://docs.python.org/pt-br/3/library/re.html" target="_blank"><img src="https://img.shields.io/badge/Regex-red?style=for-the-badge" alt="Regex"></a>
 
+## 🤖 Prototipação e Identidade Visual
+
+- *Desenvolvimento da Identidade Visual:* Investimos tempo no desenvolvimento de uma identidade visual consistente para o projeto, incluindo seleção de cores, tipografia e uma logo autêntica baseada na bandeira. Essa identidade visual reflete nossa visão e valores, e está integrada em toda a interface do usuário e materiais de design.
+
+- *Protótipo da Home:* 
+
+  ![Home Page](https://raw.githubusercontent.com/unb-mds/2024-1-MinasDeCultura/main/docs/assets/images/Home.jpg)
+
+## Protótipo de utilização da API do Querido Diário
+
+Para fins de testes, desenvolvemos um protótipo de utilização da API do Querido Diário. Tínhamos dúvidas sobre como fazer as requisições e receber os dados, então optamos por criar um formulário. Nesse formulário, o usuário pode inserir um município (limitado aos municípios de Minas Gerais), um termo de busca e um intervalo de datas. Em seguida, o sistema realiza uma solicitação à API do Querido Diário com os parâmetros fornecidos.
+
+Os dados retornados pela API são então renderizados na tela, possibilitando ao usuário visualizar todas as respostas obtidas. Essa abordagem nos permite testar a integração com a API e entender como os dados são estruturados, facilitando o desenvolvimento de futuras funcionalidades.
+
+![Protótipo](https://github.com/unb-mds/2024-1-MinasDeCultura/blob/main/prototipo_form/image.png?raw=true)
+
+## Como testar o protótipo?
+
+Inicialmente, é preciso ter instalado em sua máquina o git e o node.js. Tendo os dois instalados, basta seguis o passo a passo abaixo:
+
+### Clonar o repositório
+
+```bash
+git clone https://github.com/unb-mds/2024-1-MinasDeCultura.git
+```
+
+### Acessar o repositório
+
+```bash
+cd 2024-1-MinasDeCultura
+```
+
+### Mudar de branch
+
+```bash
+git checkout origin/prototipo_qd
+```
+
+### Acessar diretório do protótipo
+
+```bash
+cd prototipo_form
+```
+
+### Instalar dependências
+
+```bash
+npm i
+```
+
+### Iniciar servidor de desenvolvimento
+
+```bash
+npm run dev
+```
+
+Após seguir esses passos, o servidor de desenvolvimento estará em execução e você poderá acessar o protótipo em seu navegador através do endereço fornecido pelo servidor. Certifique-se de testar todas as funcionalidades conforme necessário.
+
+
+## 🤖 Prototipação web scraping 
+Passo a passo de como usar o scrapy está [aqui](https://unb-mds.github.io/2024-1-MinasDeCultura/Como%20executar/Tutorial_scrapy/)
+
 ## 📚 Documentação
  A documentação do projeto está disponível [aqui](https://unb-mds.github.io/2024-1-MinasDeCultura/)
 

diff --git a/conversor_pdf_json/conversor_pdf_json.py b/conversor_pdf_json/conversor_pdf_json.py
diff --git a/docs/Arquitetura/Arquitetura.md b/docs/Arquitetura/Arquitetura.md
@@ -78,6 +78,7 @@ Uma parte importante da nossa aplicação é aonde vamos publicar. Como não tem
 | Versão |    Data    |                                    Descrição                                     |      Autor      |
 | :----: | :--------: | :------------------------------------------------------------------------------: | :-------------: |
 |  3.0   | 25/04/2024 |                     Reestruturando Documento de Arquitetura                      | Rafael Carvalho |
+|  2.2   | 25/04/2024 |                     Adicionando emojis nos tópicos                       | Isaac Batista |
 |  2.1   | 17/04/2024 | Exemplificação de uso da API do Querido Diário e Atualização da issue de suporte | Rafael Carvalho |
 |  2.0   | 17/04/2024 |                         Crição do esboço de arquitetura                          | Gabriel Scheidt |
 |  1.0   | 14/04/2024 |                         Crição do esboço de arquitetura                          | Gabriel Scheidt |
diff --git a/docs/Arquitetura/Figma.md b/docs/Arquitetura/Figma.md
@@ -29,4 +29,5 @@ Com as bases sólidas estabelecidas, iniciamos o processo de prototipagem da tel
 | Versão |    Data    |            Descrição            |     Autor     |
 | :----: | :--------: | :-----------------------------: | :-----------: |
 |  1.0   | 24/04/2024 | Crição da documentação do Figma | Isaac Batista |
-|  1.1   | 26/04/2024 | Atualização com a nova Home | Manuella Valadares |
+|  1.1   | 25/04/2024 |                     Adicionando emojis nos tópicos                       | Isaac Batista |
+|  1.2   | 26/04/2024 | Atualização com a nova Home | Manuella Valadares |
diff --git a/docs/Como contribuir/Como_contribuir.md b/docs/Como contribuir/Como_contribuir.md
@@ -64,4 +64,5 @@ O rodapé também é uma parte opcional da mensagem de commit que pode ser usado
 ## 📁 Histórico de versão
 | Versão |    Data    |                    Descrição                    |     Autor    |
 |:------:|:----------:|:-----------------------------------------------:|:------------:|
-|  1.0   | 11/04/2024 | Adicionando histórico de versão                 | Marcos Vieira|
+|  1.0   | 11/04/2024 | Adicionando histórico de versão                 | Marcos Vieira|
+|  1.2   | 25/04/2024 |                     Adicionando emojis nos tópicos        | Isaac Batista |
diff --git a/docs/Como executar/Tutorial_scrapy.md b/docs/Como executar/Tutorial_scrapy.md
@@ -64,12 +64,20 @@ cd webscrapy/minas_de_cultura_scrapy
 
 Execução do crawler:
 ```
-scrapy crawl prototipo_spider
+scrapy crawl prototipo_spider -o resultado.json
 ```
 
-## Passo 7: Desativação do Ambiente Virtual
+passando os parâmetros no final o resultado será armazenado como json em um arquivo nomeado resultado.
+
+## Passo 7: Resultado da busca
+Para vizualizar o resultado basta dar o comando:
+```
+cat resultado.json
+```
+
+## Passo 8: Desativação do Ambiente Virtual
 
 Quando terminar, desative o ambiente virtual:
 ```
 deactivate
-```
+```
diff --git a/docs/Como executar/passo-a-passo-backend.md b/docs/Como executar/passo-a-passo-backend.md
@@ -0,0 +1,49 @@
+## Protótipo de utilização da API do Querido Diário
+
+Para fins de testes, desenvolvemos um protótipo de utilização da API do Querido Diário. Tínhamos dúvidas sobre como fazer as requisições e receber os dados, então optamos por criar um formulário. Nesse formulário, o usuário pode inserir um município (limitado aos municípios de Minas Gerais), um termo de busca e um intervalo de datas. Em seguida, o sistema realiza uma solicitação à API do Querido Diário com os parâmetros fornecidos.
+
+Os dados retornados pela API são então renderizados na tela, possibilitando ao usuário visualizar todas as respostas obtidas. Essa abordagem nos permite testar a integração com a API e entender como os dados são estruturados, facilitando o desenvolvimento de futuras funcionalidades.
+
+![Protótipo](https://github.com/unb-mds/2024-1-MinasDeCultura/blob/main/prototipo_form/image.png?raw=true)
+
+## Como testar o protótipo?
+
+Inicialmente, é preciso ter instalado em sua máquina o git e o node.js. Tendo os dois instalados, basta seguis o passo a passo abaixo:
+
+### Clonar o repositório
+
+```bash
+git clone https://github.com/unb-mds/2024-1-MinasDeCultura.git
+```
+
+### Acessar o repositório
+
+```bash
+cd 2024-1-MinasDeCultura
+```
+
+### Mudar de branch
+
+```bash
+git checkout origin/prototipo_qd
+```
+
+### Acessar diretório do protótipo
+
+```bash
+cd prototipo_form
+```
+
+### Instalar dependências
+
+```bash
+npm i
+```
+
+### Iniciar servidor de desenvolvimento
+
+```bash
+npm run dev
+```
+
+Após seguir esses passos, o servidor de desenvolvimento estará em execução e você poderá acessar o protótipo em seu navegador através do endereço fornecido pelo servidor. Certifique-se de testar todas as funcionalidades conforme necessário.
diff --git a/docs/Release/Primeira release.md b/docs/Release/Primeira release.md
diff --git a/docs/atas/ata-reunião4.md → docs/atas/ata-reuniao4.md b/docs/atas/ata-reunião4.md → docs/atas/ata-reuniao4.md
diff --git a/docs/atas/ata-reuniao5.md b/docs/atas/ata-reuniao5.md
@@ -0,0 +1,56 @@
+### ATA DE REUNIÃO - RETOMADA DOS TRABALHOS E ORGANIZAÇÃO PARA APRESENTAÇÃO DA RELEASE
+
+**Data:** 28/06/2024  
+**Hora de Início:** 09:00  
+**Plataforma:** Discord
+
+**Redator:** Gabriel Scheidt
+
+#### 1. Membros Presentes e Ausentes
+
+**Presentes:** William Bernardo, Marcos Vieira, Mateus Henrique, Manuella Valadares, Gabriel Scheidt e Isaac Batista.
+
+**Ausentes:** Nenhum
+
+#### 2. Considerações Iniciais da Reunião
+
+A reunião iniciou às 9:00 via Discord.
+Rafael Carvalho não faz mais parte do grupo
+
+#### 3. Pautas da Reunião
+
+**1ª Pauta - Revisão do Progresso do Projeto**  
+Revisamos as atividades e entregas concluídas até o momento. Discutimos o que foi realizado e identificamos pendências e áreas que precisam de atenção para garantir a continuidade do projeto.
+
+***
+
+**2ª Pauta - Planejamento da Apresentação da Release**  
+Definimos o formato e o conteúdo da apresentação da release. Alinhamos os papéis e responsabilidades de cada membro para a apresentação.
+
+***
+
+**3ª Pauta - Reavaliação do Planejamento Futuro**  
+Atualizamos o cronograma de entregas com base no progresso atual. Ajustamos as prioridades e estabelecemos novas metas para a próxima fase, garantindo que todas as etapas estejam claramente definidas.
+
+***
+
+**4ª Pauta - Organização do Trabalho e Delegação de Tarefas**  
+Repartimos as tarefas restantes entre os membros da equipe, definindo prazos e responsáveis para cada atividade. Garantimos que todas as áreas do projeto tenham responsáveis e prazos estabelecidos.
+
+***
+
+**5ª Pauta - Documentação e Compartilhamento de Informações**  
+Atualizamos a documentação do projeto com as últimas informações e decisões. Asseguramos que toda a documentação atualizada fosse compartilhada com a equipe para garantir que todos estivessem alinhados.
+
+***
+
+#### Encaminhamentos:
+
+| Atividade                           | Responsáveis                  | Prazo      |
+|-------------------------------------|-------------------------------|------------|
+| Revisão do Progresso                | Todos os Membros              | 13/07/2024 |
+| Planejamento da Apresentação        | Gabriel, Manuella           | 01/07/2024 |
+
+#### 4. Considerações Finais
+
+A reunião se encerrou às 10:30. Todos os membros estão alinhados quanto às próximas etapas e responsabilidades. As decisões e encaminhamentos foram devidamente documentados e compartilhados com a equipe.
diff --git a/docs/atas/ata-reuniao6.md b/docs/atas/ata-reuniao6.md
@@ -0,0 +1,41 @@
+### ATA DE REUNIÃO - PROGRESSO DOS TRABALHOS E ORGANIZAÇÃO PARA FUTURAS METAS
+
+**Data:** 28/06/2024  
+**Hora de Início:** 09:00  
+**Hora de Término:** 10:00  
+**Plataforma:** Discord  
+
+**Redator:** Gabriel Scheidt
+
+#### 1. Membros Presentes e Ausentes
+
+**Presentes:** William Bernardo, Marcos Vieira, Mateus Henrique, Manuella Valadares, Gabriel Scheidt, Isaac Batista.  
+**Ausentes:** Nenhum
+
+#### 2. Considerações Iniciais da Reunião
+
+A reunião iniciou às 9:00 via Discord.  
+Rafael Carvalho não faz mais parte do grupo.
+
+#### 3. Pautas da Reunião
+
+**1ª Pauta - Revisão do Progresso do Projeto**  
+Os grupos de trabalho falaram sobre seu progresso e metas futuras. Estamos finalizando o Figma e a prototipação para o front-end está avançando bem.
+
+**2ª Pauta - Decisão de Criar Backend e Banco de Dados**  
+Foi decidido, com base no feedback da professora, criar um backend e um banco de dados para suportar o projeto.
+
+**3ª Pauta - Implementação do Docker**  
+Resolvemos criar um Docker para facilitar o processo de rodar o nosso serviço nos computadores de desenvolvimento.
+
+#### Encaminhamentos:
+
+| Atividade                           | Responsáveis                  | Prazo      |
+|-------------------------------------|-------------------------------|------------|
+| Finalização do Figma                | Todos os Membros              | 05/07/2024 |
+| Desenvolvimento do Backend           | Isaac Batista   | 12/07/2024 |
+| Implementação do Docker              | William Bernado | 12/07/2024 |
+
+#### 4. Considerações Finais
+
+A reunião se encerrou às 10:00. Todos os membros estão alinhados quanto às próximas etapas e responsabilidades. As decisões e encaminhamentos foram devidamente documentados e compartilhados com a equipe.
diff --git a/docs/index.md b/docs/index.md
@@ -88,5 +88,6 @@ Através desta aplicação, buscamos oferecer uma maneira mais transparente e ac
 
 | Versão |    Data    |                    Descrição                    |     Autor      |
 |:------:|:----------:|:-----------------------------------------------:|:--------------:|
-|  1.0   | 11/04/2024 | Adicionando histórico de versão                 | Gabriel Scheidt|
-|  1.1   | 26/04/2024 | adicionando prototipação e identidade visual    | Manuella Valadares|
+|  1.0   | 11/04/2024 |           Adicionando histórico de versão       | Gabriel Scheidt|
+|  1.1   | 25/04/2024 |           Adicionando emojis nos tópicos        | Isaac Batista  |
+|  1.2   | 26/04/2024 | Adicionando prototipação e identidade visual    | Manuella Valadares|