Merge remote-tracking branch 'refs/remotes/origin/main'

unb-mds · Apr 26, 2024 · 94f3467 · 94f3467
2 parents 342fec3 + 69606b7
commit 94f3467
Show file tree

Hide file tree

Showing 7 changed files with 65 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -12,6 +12,8 @@ Através desta aplicação, buscamos oferecer uma maneira mais transparente e ac
     - [⚙️ Funcionalidades](#%EF%B8%8F-funcionalidades-previstas)
     - [💻 Tecnologias](#-tecnologias)
     - [🤖 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)
@@ -53,6 +55,57 @@ Através desta aplicação, buscamos oferecer uma maneira mais transparente e ac
 
   ![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/)
 

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/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|
diff --git a/docs/visão geral/backlog.md b/docs/visão geral/backlog.md
@@ -59,4 +59,5 @@
 | Versão |    Data    |                    Descrição                    |     Autor      |
 |:------:|:----------:|:-----------------------------------------------:|:--------------:|
 |  1.0   | 02/04/2024 | Adicionando história de usuários                | Gabriel Scheidt|
-|  1.0   | 02/04/2024 | Adicionando histórico de versão                 | Gabriel Scheidt|
+|  1.0   | 02/04/2024 | Adicionando histórico de versão                 | Gabriel Scheidt|
+|  1.2   | 25/04/2024 |                     Adicionando emojis nos tópicos                       | Isaac Batista |
diff --git a/docs/visão geral/storymap.md b/docs/visão geral/storymap.md
@@ -6,4 +6,5 @@
 
 | Versão |    Data    |                    Descrição                    |     Autor      |
 |:------:|:----------:|:-----------------------------------------------:|:--------------:|
-|  1.0   | 02/04/2024 | Adicionando histórico de versão                 | Gabriel Scheidt|
+|  1.0   | 02/04/2024 | Adicionando histórico de versão                 | Gabriel Scheidt|
+|  1.1   | 25/04/2024 |                     Adicionando emojis nos tópicos                       | Isaac Batista |