docs/atualizando documentação

FGA0138-MDS-Ajax · Nov 1, 2023 · 5b08b05 · 5b08b05
1 parent bbe8304
commit 5b08b05
Show file tree

Hide file tree

Showing 20 changed files with 231 additions and 57 deletions.
diff --git a/.gitignore b/.gitignore
@@ -2,3 +2,9 @@
 /node_modules
 /.pnp
 .pnp.js
+
+# Ignorar módulos do Node.js no frontend
+Frontend/node_modules/
+
+# Ignorar módulos do Node.js no backend
+Backend/node_modules/
diff --git a/Apresentações/1° Apresentação.pdf → ...es/1° Apresentação - Visão do Produto.pdf b/Apresentações/1° Apresentação.pdf → ...es/1° Apresentação - Visão do Produto.pdf
diff --git a/Apresentações/2° Apresentação - Arquitetura.pdf b/Apresentações/2° Apresentação - Arquitetura.pdf
diff --git a/Atas/1 Reunião.pdf → Atas/1° Reunião.pdf b/Atas/1 Reunião.pdf → Atas/1° Reunião.pdf
diff --git a/Atas/3ª Reunião.pdf → Atas/3° Reunião.pdf b/Atas/3ª Reunião.pdf → Atas/3° Reunião.pdf
diff --git a/Atas/ata 4.pdf → Atas/4° Reunião.pdf b/Atas/ata 4.pdf → Atas/4° Reunião.pdf
diff --git a/Atas/5ª Reunião.pdf → Atas/5° Reunião.pdf b/Atas/5ª Reunião.pdf → Atas/5° Reunião.pdf
diff --git a/README.md b/README.md
@@ -1,11 +1,21 @@
 # 2023-2-POLLUX
 
-## Documentação
-- [Documento Visão](/Entregas/Documento%20Visão.pdf)
-- [Declaração de Escopo](/Entregas/Declaração%20de%20Escopo%20do%20Produto.pdf)
-
 ## MkDocs
 - [Link para o mkdocs da equipe](https://fga0138-mds-ajax.github.io/2023-2-POLLUX/)
 
+## Entregáveis
+- [Documento Visão](/Entregas/Documento%20Visão.pdf)
+- [Declaração de Escopo](/Entregas/Declaração%20de%20Escopo%20do%20Produto.pdf)
+- [Documento de Arquitetura](/Entregas/)
+
 ## Apresentações
-- [1° Apresentação - 04/09/2023](Apresentações/1°%20Apresentação.pdf)
+- [1° Apresentação - Visão do Produto - 04/09/2023](Apresentações/1°%20Apresentação.pdf)
+- [1° Apresentação - Arquitetura - 01/11/2023](Apresentações/2°%20Apresentação%20-%20Arquitetura.pdf)
+
+## Atas 
+- [1° Reunião](/Atas/1°%20Reunião.pdf)
+- [2° Reunião](/Atas/2°%20Reunião.pdf)
+- [3° Reunião](/Atas/3°%20Reunião.pdf)
+- [4° Reunião](/Atas/4°%20Reunião.pdf)
+- [5° Reunião](/Atas/5°%20Reunião.pdf)
+
diff --git a/docs/documentoArquitetura.md b/docs/documentoArquitetura.md
diff --git a/docs/sprints.md b/docs/sprints.md
@@ -4,4 +4,7 @@
 - [*Sprint 3*](./sprints/sprint3.md)
 - [*Sprint 4*](./sprints/sprint4.md)
 - [*Sprint 5*](./sprints/sprint5.md)
-- [*Sprint 6*](./sprints/sprint6.md)
+- [*Sprint 6*](./sprints/sprint6.md)
+- [*Sprint 7*](./sprints/sprint7.md)
+- [*Sprint 8*](./sprints/sprint8.md)
+
diff --git a/docs/sprints/sprint0.md b/docs/sprints/sprint0.md
@@ -3,20 +3,29 @@
 - **Período:** 05/09/2023 a 12/09/2023
 - **Objetivo:** O objetivo principal desta sprint foi realizar a escolha do tema e a definição do escopo, garantindo assim uma base sólida para o desenvolvimento do projeto.
 
+---
+
 ## **Issues**
 
 |Atividade|Histórias de Usuário Envolvidas|Descrição|Responsáveis|Status da Entrega|
 |:----:|:----------:|:----------:|:------:|:--:|
 |#1|--| Escolha do Tema | Eric e Isaque | Ok |
 |#2|--| Definição do Escopo |  Nicollas, Samuel e Rodrigo  | Ok | 
 
-## **Review** 
+## **Review das Atividades**
+
+---
+
+### **Atividade #1**
+**Status:** Concluída
+
+A equipe escolheu como tema o desenvolvimento de uma aplicação web destinada à avaliação e consulta de professores da Faculdade do Gama (FGA).
 
-### ***Atividade 1***
-**Concluída.** A equipe escolheu como tema o desenvolvimento de uma aplicação web destinada à avaliação e consulta de professores da Faculdade do Gama (FGA).
+---
 
-### ***Atividade 2***
-**Concluída.** A equipe realizou com sucesso o levantamento inicial de requisitos.
+### **Atividade #2**
+**Status:** Concluída
 
+A equipe realizou com sucesso o levantamento inicial de requisitos.
 
 
diff --git a/docs/sprints/sprint1.md b/docs/sprints/sprint1.md
@@ -3,20 +3,27 @@
 - **Período:** 12/09/2023 a 19/02/2023
 - **Objetivo:** Para esta sprint, priorizamos a definição das tecnologias e o treinamento da equipe
 
+---
+
 ## **Issues**
 
 |Atividade|Histórias de Usuário Envolvidas|Descrição|Responsáveis|Status da Entrega|
 |:----:|:----------:|:----------:|:------:|:--:|
 |#1|--| Definição de Tecnologias | Eric e Isaque | Ok |
 |#2|--| Treinamento da Equipe |  Nicollas, Samuel e Rodrigo  | Ok |
 
-## **Review** 
+## **Review das Atividades**
+
+---
 
-### ***Atividade #1***
-**Concluída.**  A equipe optou por utilizar ReactJS para o desenvolvimento do Frontend e NodeJS para o desenvolvimento do Backend, tendo decidido também utilizar o MongoDB como banco de dados.
+### **Atividade #1**
+**Status:** Concluída
 
-### ***Atividade #2***
-**Concluída.** A equipe passou por um treinamento inicial nas tecnologias escolhidas antes de iniciar o desenvolvimento.
+A equipe optou por utilizar ReactJS para o desenvolvimento do Frontend e NodeJS para o desenvolvimento do Backend, tendo decidido também utilizar o MongoDB como banco de dados.
 
+---
 
+### **Atividade #2**
+**Status:** Concluída
 
+A equipe passou por um treinamento inicial nas tecnologias escolhidas antes de iniciar o desenvolvimento.
diff --git a/docs/sprints/sprint2.md b/docs/sprints/sprint2.md
@@ -3,13 +3,19 @@
 - **Período:** 19/09/2023 a 26/09/2023
 - **Objetivo:** Nesta sprint, foi visado o desinvolvimento de protótipo fieis às telas da nossa aplicação utilizando a ferramenta Figma. 
 
+---
+
 ## **Issues**
 
 |Atividade|Histórias de Usuário Envolvidas|Descrição|Responsáveis|Status da Entrega|
 |:----:|:----------:|:----------:|:------:|:--:|
 |#1|--| Protótipo de Telas no Figma| Eric, Isaque,Nicollas, Samuel e Rodrigo | Ok |
 
-## **Review** 
+## **Review das Atividades**
+
+---
+
+### **Atividade #1**
+**Status:** Concluída
 
-### ***Atividade 1***
-**Concluída.** A equipe criou todos os designs e protótipos das telas da aplicação no Figma, seguindo os requisitos estabelecidos.
+A equipe criou todos os designs e protótipos das telas da aplicação no Figma, seguindo os requisitos estabelecidos.
diff --git a/docs/sprints/sprint3.md b/docs/sprints/sprint3.md
@@ -3,6 +3,8 @@
 - **Período:** 26/09/2023 a 03/10/2023 
 - **Objetivo:** Nesta sprint, foi realizada a primeira divisão de tarefas entre os membros que se dividaram em frontend e backend. Enquanto o frontend focou em desenvolver as telas de login e cadastro e backend ficou responsável pela criação do banco de dados da aplicação. 
 
+---
+
 ## **Issues**
 
 |Atividade|Histórias de Usuário Envolvidas|Descrição|Responsáveis|Status da Entrega|
@@ -11,15 +13,25 @@
 |#2|US-01, US-02, US-03| Desenvolver da tela de cadastro | Eric e Isaque  | Ok |
 |#3|--| Criação do banco de dados da aplicação |  Nicollas, Samuel e Rodrigo  | Ok |
 
-## **Review** 
+## **Review das Atividades**
+
+---
+
+### **Atividade #1**
+**Status:** Concluída
+
+A estrutura da tela de login foi desenvolvida com sucesso.
+
+---
 
-### ***Atividade #1***
-**Concluída.**  A estrutura da tela de login foi desenvolvida com sucesso.
+### **Atividade #2**
+**Status:** Concluída
 
-### ***Atividade #2***
-**Concluída.** A estrutura da tela de cadastro foi desenvolvida com sucesso.
+A estrutura da tela de cadastro foi desenvolvida com sucesso.
 
-### ***Atividade #3***
-**Concluída.**  Criação bem-sucedida do banco de dados no MongoDB, incluindo a realização da conexão.
+---
 
+### **Atividade #3**
+**Status:** Concluída
 
+Criação bem-sucedida do banco de dados no MongoDB, incluindo a realização da conexão.
diff --git a/docs/sprints/sprint4.md b/docs/sprints/sprint4.md
@@ -3,6 +3,8 @@
 - **Período:** 03/10/2023 a 10/10/2023
 - **Objetivo:** Nessa Sprint decidimos implementar funcionalidades e discutimos funcionalidades futuras optando por já alimentar a base de dados.
 
+---
+
 ## **Issues**
 
 |Atividade|Histórias de Usuário Envolvidas|Descrição|Responsáveis|Status da Entrega|
@@ -12,22 +14,35 @@
 |#3|US-02| Lógica de autenticação pela parte do usuário |  Eric, Isaque  | Ok |
 |#4|--| Iniciar documentação no MkDocs  |  Nicollas, Samuel e Rodrigo  | Ok |
 
-## **Review**
+## **Review das Atividades**
+
+---
+
+### **Atividade #1**
+**Status:** Concluída
+
+Desenvolvimento do CRUD de usuário realizado com sucesso, abrangendo as operações de criação, leitura, atualização e exclusão.
+
+---
+
+### **Atividade #2**
+**Status:** Concluída
 
-### ***Atividade #1***
-**Concluída.**  Desenvolvimento do CRUD de usuário realizado com sucesso, abrangendo as operações de criação, leitura, atualização e exclusão.
+Realizada a alimentação da base de dados com informações de professores por meio de web scraping através do sigaa.
 
-### ***Atividade #2***
-**Concluída.** Realizada a alimentação da base de dados com informações de professores por meio de web scraping através do sigaa.
+---
 
-### ***Atividade #3***
-**Concluída.**  Implementada com sucesso a lógica de autenticação pelo lado do usuário, garantindo a segurança e o controle de acesso ao sistema.
+### **Atividade #3**
+**Status:** Concluída
 
-### ***Atividade #4***
-**Concluída.**  A equipe deu início a um projeto no MkDocs hospedado no GitPages, marcando o começo do processo de documentação abrangente do projeto.
+Implementada com sucesso a lógica de autenticação pelo lado do usuário, garantindo a segurança e o controle de acesso ao sistema.
 
+---
 
+### **Atividade #4**
+**Status:** Concluída
 
+A equipe deu início a um projeto no MkDocs hospedado no GitPages, marcando o começo do processo de documentação abrangente do projeto.
 
 
 
diff --git a/docs/sprints/sprint5.md b/docs/sprints/sprint5.md
@@ -3,6 +3,8 @@
 - **Período:** 10/10/2023 a 17/10/2023
 - **Objetivo:** Nessa sprint, descidimos testar a integração do Frontend com o Backend com toda a lógica de registro e autenticação através de testes das rotas.
 
+---
+
 ## **Issues**
 
 |Atividade|Histórias de Usuário Envolvidas|Descrição|Responsáveis|Status da Entrega|
@@ -13,19 +15,39 @@
 |#4|US-01| Integração do Front e Back no login e cadastro |  Eric, Isaque, Nicollas, Samuel e Rodrigo   | Ok | 
 |#5|--| Importar banco de dados no backend |  Nicollas, Samuel e Rodrigo   | Ok | 
 
-## **Review**
+## **Review das Atividades**
+
+---
+
+### **Atividade #1**
+**Status:** Concluída
+
+Lógica de registro do usuário desenvolvida no front, permitindo que novos usuários se cadastrem no sistema.
+
+---
+
+### **Atividade #2**
+**Status:** Concluída
+
+Foram implementadas as rotas no backend para o cadastro de usuário, possibilitando que os usuários criem suas contas.
+
+---
+
+### **Atividade #3**
+**Status:** Concluída
+
+A estrutura da página inicial foi desenvolvida com sucesso.
+
+---
 
-### ***Atividade #1***
-**Concluída.**  Lógica de registro do usuário desinvolvida no front, permitindo que novos usuários se cadastrem no sistema. 
+### **Atividade #4**
+**Status:** Concluída
 
-### ***Atividade #2***
-**Concluída.** implementadas as rotas no backend para o cadastro de usuário, possibilitando que os usuários criem suas contas 
+A integração das rotas de autenticação e registro do usuário foi implementada com a utilização do Axios.
 
-### ***Atividade #3***
-**Concluída.**  A estrutura da página inicial foi desenvolvida com sucesso.
+---
 
-### ***Atividade #4***
-**Concluída.**  Integração das rotas de autenticação e registro do usuário implementada com utilização do axios. 
+### **Atividade #5**
+**Status:** Concluída
 
-### ***Atividade #5***
-**Concluída.**  A conexão com o banco de dados foi bem sucessidida. Assim, as rotas podem fazer referência aos dados armazenados dentro do banco. Entretanto, as requisições estão um pouco lentas. Assim, a equipe decidiu inserir a otimização da conexão na próxima sprint. 
+A conexão com o banco de dados foi bem-sucedida. Assim, as rotas podem fazer referência aos dados armazenados dentro do banco. No entanto, as requisições estão um pouco lentas. A equipe decidiu inserir a otimização da conexão na próxima sprint.
diff --git a/docs/sprints/sprint6.md b/docs/sprints/sprint6.md
@@ -3,6 +3,8 @@
 - **Período:** 17/10/2023 a 24/10/2023
 - **Objetivo:** Nessa sprint, otimizamos a importação do mongoDB no banckend por conta da lentidão nas requisições contestada na sprint passada. Começamos as implementaçoes de novas funcionalidades.
 
+ ---
+
 ## **Issues**
 
 |Atividade|Histórias de Usuário Envolvidas|Descrição|Responsáveis|Status da Entrega|
@@ -12,17 +14,32 @@
 |#3|US-01| Melhorar usabilidade de login e cadastro para usuário|  Nicollas, Samuel e Rodrigo   | Ok | 
 |#4|US-05| Implementar API para busca de professores|  Nicollas, Samuel e Rodrigo   | Adiado | 
 
-## **Review**
+## **Revisão de Atividades**
+
+---
+
+### **Atividade #1**
+**Status:** Concluída
+
+A equipe de backend focou seus esforços na otimização da conexão com o MongoDB, o que resultou em melhorias significativas na velocidade das requisições de registro e autenticação de usuários.
+
+---
+
+### **Atividade #2**
+**Status:** Concluída
+
+A estrutura da barra de pesquisa foi implementada com sucesso. No entanto, a parte lógica da busca do lado do cliente foi temporariamente impedida de avançar devido à falta da implementação da API que fornece os dados dos professores.
+
+---
 
-### ***Atividade #1***
-**Concluída.**  A equipe de backend concentrou-se na otimização da conexão com o MongoDB, resultando em melhorias significativas na velocidade das requisições de registro e autenticação de usuários.
+### **Atividade #3**
+**Status:** Concluída
 
-### ***Atividade #2***
-**Concluída.** A estrutura da barra de pesquisa foi implementada com sucesso. No entanto, a parte lógica da busca que deve ser desenvolvida no lado do cliente foi temporariamente impedida de avançar, devido à falta da implementação da API que fornece os dados dos professores.
+A equipe de frontend aprimorou a usabilidade das páginas de login e cadastro para o usuário. Foram adicionadas mensagens de erro específicas para os seguintes casos: 'Email ou senha incorretos', 'Preencha todos os campos' e 'As senhas não coincidem'.
 
-### ***Atividade #3***
-**Concluída.**  A equipe de frontend aprimorou a usabilidade das páginas de login e cadastro para o usuário. Foram adicionadas mensagens de erro específicas para os seguintes casos: 'Email ou senha incorretos', 'Preencha todos os campos' e 'As senhas não coincidem
+---
 
-### ***Atividade #4***
-**Inconcluída.**  A implementação da API que fornecerá os dados dos professores não pôde ser realizada devido à falta de tempo dos membros da equipe. Esta tarefa será adiada para as próximas sprints.
+### **Atividade #4**
+**Status:** Inconcluída
 
+A implementação da API que fornecerá os dados dos professores não pôde ser realizada devido à falta de tempo dos membros da equipe. Esta tarefa será adiada para as próximas sprints.
diff --git a/docs/sprints/sprint7.md b/docs/sprints/sprint7.md
@@ -0,0 +1,49 @@
+# **Planning da Sprint 7**
+
+- **Período:** 24/10/2023 a 31/10/2023
+- **Objetivo:** Finalizar funcionalidade de busca de professores através da criação da api no backend e cards dos professores no frontend.
+
+---
+
+## **Issues**
+
+|Atividade|Histórias de Usuário Envolvidas|Descrição|Responsáveis|Status da Entrega|
+|:----:|:----------:|:----------:|:------:|:--:|
+|#1|US-05| Desenvolver componente de card dos professores| Eric e Isaque | Ok |
+|#2|US-05, US-07, US-08, US-10| Realizar novo webscrapping para coleta de dados dos professores do sigaa| Nicollas, Samuel e Isaque | Ok |
+|#3|US-05| Implementar API que forneçe dados dos professores para o frontend| Nicollas, Samuel e Isaque | Ok |
+|#3|US-05| Implementar lógica de busca de professores pelo lado do cliente| Eric e Isaque| Ok |
+
+## **Review das Atividades**
+
+---
+
+### **Atividade #1**
+
+**Status:** Concluída
+
+O componente que renderiza os dados do professor no momento da busca do usuário foi concluído. No entanto, o layout do card ainda está em aberto.
+
+---
+
+### **Atividade #2**
+
+**Status:** Concluída
+
+O componente que renderiza os dados do professor no momento da busca do usuário foi concluído. No entanto, o layout do card ainda está em aberto.
+
+---
+
+### **Atividade #3**
+
+**Status:** Concluída
+
+A API de pesquisa de professores foi efetuada de maneira correta. A url recebe o nome ou inicial do professor e retorna um array filtrado.
+
+---
+
+### **Atividade #4**
+
+**Status:** Concluída
+
+A lógica consiste em receber o input do usuário e fazer a requisição ao back através de uma chamada do axios.