From 2414bea67189886ab4c61e0aed1eb8a6daaa347c Mon Sep 17 00:00:00 2001 From: isaacbatista26 Date: Fri, 26 Apr 2024 08:43:38 -0300 Subject: [PATCH 1/2] =?UTF-8?q?docs:=20atualizando=20hist=C3=B3rico=20de?= =?UTF-8?q?=20vers=C3=A3o?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/Arquitetura/Arquitetura.md | 1 + docs/Arquitetura/Figma.md | 3 ++- docs/Como contribuir/Como_contribuir.md | 3 ++- docs/index.md | 5 +++-- "docs/vis\303\243o geral/backlog.md" | 3 ++- "docs/vis\303\243o geral/storymap.md" | 3 ++- 6 files changed, 12 insertions(+), 6 deletions(-) diff --git a/docs/Arquitetura/Arquitetura.md b/docs/Arquitetura/Arquitetura.md index 675c2c7..c2bf2f1 100644 --- 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 index 50457b9..9f273d6 100644 --- 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 index 154ef36..eda2446 100644 --- 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| \ No newline at end of file +| 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 | \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 03e3e4c..2f5b757 100644 --- 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| \ No newline at end of file +| 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| \ No newline at end of file diff --git "a/docs/vis\303\243o geral/backlog.md" "b/docs/vis\303\243o geral/backlog.md" index 99adecf..f4141a5 100644 --- "a/docs/vis\303\243o geral/backlog.md" +++ "b/docs/vis\303\243o 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| \ No newline at end of file +| 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 | \ No newline at end of file diff --git "a/docs/vis\303\243o geral/storymap.md" "b/docs/vis\303\243o geral/storymap.md" index 1f45504..eb6c115 100644 --- "a/docs/vis\303\243o geral/storymap.md" +++ "b/docs/vis\303\243o 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| \ No newline at end of file +| 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 | \ No newline at end of file From 69606b77bbc093c728e070cabf4725007729009d Mon Sep 17 00:00:00 2001 From: Manuella Valadares <119461383+manuvaladares@users.noreply.github.com> Date: Fri, 26 Apr 2024 08:59:07 -0300 Subject: [PATCH 2/2] Update README.md --- README.md | 53 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 53 insertions(+) diff --git a/README.md b/README.md index 1f353c0..19e7a8d 100644 --- 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/)