Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ajuste na documentação do projeto #174

Merged
merged 5 commits into from
Sep 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,12 +74,12 @@ yarn
```
> Cadastre os dados do seu aplicativo do FireBase criando um arquivo `.env` preenchendo-o com as seguintes infomações
```bash
VITE_API_KEY=
VITE_AUTH_DOMAIN=
VITE_PROJECT_ID=
VITE_STORAGE_BUCKET=
VITE_MESSAGING_SENDER_ID=
VITE_APP_ID=
VITE_VERCEL_API_KEY=
VITE_VERCEL_AUTH_DOMAIN=
VITE_VERCEL_PROJECT_ID=
VITE_VERCEL_STORAGE_BUCKET=
VITE_VERCEL_MESSAGING_SENDER_ID=
VITE_VERCEL_APP_ID=
```
**Obs:** Os dados do cadastro estão localizados em **Configuracoes do projeto > Geral** na página do projeto do Firebase, devendo ser preenchidos sem as aspas nos seus respectivos campos do arquivo .env

Expand Down
2 changes: 1 addition & 1 deletion documentation/mkdocs/docs/Arquitetura.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Arquitetura do Projeto

![Architecture](./assets/newArchitecture.png)
![Architecture](./assets/architecture.png)
Link para melhor visualização: https://miro.com/app/board/uXjVKoxN9n8=/

## Visão Geral
Expand Down
2 changes: 1 addition & 1 deletion documentation/mkdocs/docs/Requisitos.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ ESCOPO MÍNIMO DO MVP1: #U1, #U2, #AU1, #U3, #U4, #U5, #U6, #U7, #U8, #U9, #U10,
- Editar Curso ✅
- Editar Semestre ✅
- Trocar Senha ❌
- Editar notificações
- Editar notificações
- Excluir conta ✅


Expand Down
61 changes: 61 additions & 0 deletions documentation/mkdocs/docs/Reunioes/Reuniao26.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
### 02/09/2024

- **Horário:** 20:00 - 20:50
- **Local:** Discord
- **Participantes:** Antonio, Cristiano, Felipe, Lucca, Pedro, Túlio

#### Ata

A reunião teve como objetivo discutir a conclusão das tarefas da sprint e a definição do que ainda precisa ser feito. Todos os participantes relataram o progresso de suas atividades, com alguns ajustes ainda a serem feitos antes do final da sprint.

- **Conclusão das Tarefas**:

- **Documentação**: Antonio e Pedro finalizaram a maior parte da documentação, restando apenas melhorias no diagrama da arquitetura do projeto.
- **Deploy**: Lucca ainda precisa concluir o deploy da aplicação utilizando o Vercel.

- **Tarefas para Lucca e Túlio**:

- **Criação de Testes Unitários**:
- **Objetivo**: Garantir a qualidade e a confiabilidade do código através de testes unitários, cobrindo as funcionalidades principais da aplicação.
- **Etapas**:
1. **Identificar Funcionalidades para Testes**: Mapeamento das funcionalidades principais que precisam de cobertura.
2. **Escrever Testes Unitários**: Desenvolvimento de testes utilizando o framework adequado.
3. **Configurar Ambiente de Testes**: Garantir que o ambiente esteja configurado para a execução dos testes.
4. **Documentar Testes Criados**: Descrição e instruções dos testes para referência futura.
5. **Executar e Validar Testes**: Execução e validação dos resultados, garantindo que a cobertura de código esteja em um nível satisfatório.
- **Critérios de Aceitação**:
- Todos os testes unitários devem estar implementados e documentados.
- O ambiente de testes deve permitir a execução eficiente dos testes.
- A cobertura de código deve atingir um nível aceitável conforme definido pela equipe.

- **Tarefas para Pedro**:

- **Melhorias no Front-End**:
- **Objetivo**: Melhorar o design do front-end do site com base no feedback da Carla.
- **Ajustes Necessários**:
- Simplificar a **LandingPage**, diminuindo a quantidade de texto.
- Ajustar o espaçamento da página de **Exams**.

- **Tarefas para Cristiano e Felipe**:

- **Correções de Bugs**:
- **Formulário de Adição de Provas**: Corrigir bug que mantém o último preenchimento no formulário.
- **Botão de Edição da Library**: Padronizar o botão de edição.
- **Modal de Edição**: Corrigir bug que mantém o estado de edição após fechar o modal.

- **Tarefas para Antonio e Pedro**:

- **Atualização da Documentação**:
- Adicionar as novas reuniões e sprints.
- Marcar como cumpridos os requisitos das últimas sprints.
- Melhorar o diagrama da arquitetura do projeto.

- **Tarefa para Lucca**:
- **Deploy da Página**: Realizar o deploy da página utilizando o Vercel.

---

#### Encaminhamentos

- **Apresentação da Release 2**: Todos os participantes devem estar prontos para a apresentação da proposta do projeto, juntamente das funcionalidades do mesmo, arquitetura especificada, testes realizados e melhorias gerais.
- **Reunião de Acompanhamento**: Uma nova reunião será agendada para acompanhar o progresso e garantir que estão bem claras as divisões do que será falado na apresentação do projeto na Release 2.
85 changes: 85 additions & 0 deletions documentation/mkdocs/docs/Sprints/Sprint14.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
# Sprint 14 - Preparação para Entrega do MVP1

**Período: 30/09/2024 - 04/10/2024**

## Descrição

Nesta milestone (Sprint 14), o foco está na preparação do projeto para a entrega do MVP1. Serão realizados scripts de testes automatizados para verificação das páginas, melhorias no front-end e na documentação do projeto com base no feedback da professora. Além disso, será feito o deploy do site utilizando o Vercel.

---

## Objetivos

- **Automatizar Testes das Páginas**: Implementar scripts de testes automatizados para verificar a usabilidade dos componentes das páginas.

- **Melhorar a Documentação**: Alinhar a documentação do projeto, com ênfase na arquitetura do site.

- **Ajustar o Front-End**: Implementar mudanças visuais nas páginas com base no feedback recebido da professora.

- **Fazer o Deploy**: Publicar o site do projeto na web utilizando o Vercel.

---

## Reuniões da Sprint

### 02/09/2024

- **Horário:** 20:00 - 20:50
- **Local:** Discord
- **Participantes:** Antonio, Cristiano, Felipe, Lucca, Pedro, Túlio

#### Ata

A reunião teve como objetivo discutir a conclusão das tarefas da sprint e definir o que ainda precisa ser feito. Todos os participantes relataram o progresso de suas atividades, com alguns ajustes ainda a serem realizados antes do final da sprint.

- **Conclusão das Tarefas**:

- **Documentação**: Antonio e Pedro finalizaram a maior parte da documentação, restando apenas melhorias no diagrama da arquitetura do projeto.
- **Deploy**: Lucca ainda precisa concluir o deploy da aplicação utilizando o Vercel.

- **Tarefas para Lucca e Túlio**:

- **Criação de Testes Unitários**:
- **Objetivo**: Garantir a qualidade e a confiabilidade do código através de testes unitários, cobrindo as funcionalidades principais da aplicação.
- **Etapas**:
1. **Identificar Funcionalidades para Testes**: Mapear as funcionalidades principais que precisam de cobertura.
2. **Escrever Testes Unitários**: Desenvolver testes utilizando o framework adequado.
3. **Configurar Ambiente de Testes**: Garantir que o ambiente esteja configurado para a execução dos testes.
4. **Documentar Testes Criados**: Descrever e instruir os testes para referência futura.
5. **Executar e Validar Testes**: Executar e validar os resultados, garantindo que a cobertura de código esteja em um nível satisfatório.
- **Critérios de Aceitação**:
- Todos os testes unitários devem estar implementados e documentados.
- O ambiente de testes deve permitir a execução eficiente dos testes.
- A cobertura de código deve atingir um nível aceitável conforme definido pela equipe.

- **Tarefas para Pedro**:

- **Melhorias no Front-End**:
- **Objetivo**: Melhorar o design do front-end do site com base no feedback da professora.
- **Ajustes Necessários**:
- Simplificar a **LandingPage**, diminuindo a quantidade de texto.
- Ajustar o espaçamento da página de **Exams**.

- **Tarefas para Cristiano e Felipe**:

- **Correções de Bugs**:
- **Formulário de Adição de Provas**: Corrigir bug que mantém o último preenchimento no formulário.
- **Botão de Edição da Library**: Padronizar o botão de edição.
- **Modal de Edição**: Corrigir bug que mantém o estado de edição após fechar o modal.

- **Tarefas para Antonio e Pedro**:

- **Atualização da Documentação**:
- Adicionar as novas reuniões e sprints.
- Marcar como cumpridos os requisitos das últimas sprints.
- Melhorar o diagrama da arquitetura do projeto.

- **Tarefa para Lucca**:
- **Deploy da Página**: Realizar o deploy da página utilizando o Vercel.

---

#### Encaminhamentos

- **Apresentação da Release 2**: Todos os participantes devem estar prontos para a apresentação do projeto, incluindo as funcionalidades, arquitetura especificada, testes realizados e melhorias gerais.
- **Reunião de Acompanhamento**: Uma nova reunião será agendada para acompanhar o progresso e garantir que estão claras as divisões do que será apresentado na Release 2.
Binary file modified documentation/mkdocs/docs/assets/architecture.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed documentation/mkdocs/docs/assets/newArchitecture.png
Binary file not shown.
5 changes: 5 additions & 0 deletions documentation/mkdocs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,9 @@ nav:
- Reunião 21: Reunioes/Reuniao21.md
- Reunião 22: Reunioes/Reuniao22.md
- Reunião 23: Reunioes/Reuniao23.md
- Reunião 24: Reunioes/Reuniao24.md
- Reunião 25: Reunioes/Reuniao25.md
- Reunião 26: Reunioes/Reuniao26.md
- Sprints:
- Sprint 0: Sprints/Sprint0.md
- Sprint 1: Sprints/Sprint1.md
Expand All @@ -48,6 +51,8 @@ nav:
- Sprint 10: Sprints/Sprint10.md
- Sprint 11: Sprints/Sprint11.md
- Sprint 12: Sprints/Sprint12.md
- Sprint 13: Sprints/Sprint13.md
- Sprint 14: Sprints/Sprint14.md
- Referências: Referencias.md


2 changes: 1 addition & 1 deletion index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html lang="pt-BR">
<head>
<meta charset="UTF-8" />
<link rel="icon" type="image/svg+xml" href="/vite.svg" />
<link rel="icon" type="image/svg+xml" href="/images/logo.svg" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>UnBHUB</title>
</head>
Expand Down
Loading