diff --git a/docs/sprints/sprint-1.md b/docs/sprints/sprint-1.md index b1903e85..839ce5c4 100644 --- a/docs/sprints/sprint-1.md +++ b/docs/sprints/sprint-1.md @@ -4,7 +4,7 @@ Período: 11/09/2023 a 20/09/2023 ## Descrição -Nessa _Sprint_ o time teve a redefinição dos horários das reuniões devido a mudança de horário de um dos membros. Além disso, foi definido que o time irá utilizar o _GitHub Projects_ para gerenciar as _issues_ e _milestones_ do projeto. Além disso, todos foram definidos coelhos para estudar as tecnologias que serão utilizadas no projeto, mas de forma específica, ou seja, cada membro estudará a tecnologia que vai utilizar durante o projeto. Por fim, foi definido que o time irá utilizar o _GitHub Projects_ para gerenciar as _issues_ e _milestones_ do projeto. +Nessa _Sprint_ o time teve a redefinição dos dias das reuniões, mudando para quarta-feira, devido a disponibilidade de horário de um dos membros. Além disso, foi definido que o time irá utilizar o _GitHub Projects_ para gerenciar as _issues_ e _milestones_ do projeto. Além disso, todos foram definidos coelhos para estudar as tecnologias que serão utilizadas no projeto, mas de forma específica, ou seja, cada membro estudará a tecnologia que vai utilizar durante o projeto. Por fim, foi definido que o time irá utilizar o _GitHub Projects_ para gerenciar as _issues_ e _milestones_ do projeto. ## Objetivos diff --git a/docs/sprints/sprint-10.md b/docs/sprints/sprint-10.md new file mode 100644 index 00000000..7249a242 --- /dev/null +++ b/docs/sprints/sprint-10.md @@ -0,0 +1,41 @@ +# Sprint 10 + +Período: 15/11/2023 a 22/11/2023 + +## Descrição + +Nessa Sprint, o time se reuniu para discutir sobre as tarefas que seriam realizadas. +Para o back-end, houve a criação do sistema de logout de sessão do Google OAuth e a criação de grades de disciplinas. +Já para o front-end, houve a criação e ajustes das telas cujo sistemas de back-end já estavam prontos. + +## Objetivos + +- Implementar o sistema de logout de sessão do Google OAuth +- Implementar grades de disciplinas +- Atualizar a tela de grades de disciplinas + +## Reuniões + +### Reunião 1 + +Data: 15/11/2023 + +Local: Gather Town + +**Ata:** + +Nessa reunião, o time se juntou para discutir sobre as tarefas que seriam realizadas durante a Sprint. Portanto foi definido que o time de DevOps iria auxiliar o time de front-end na implementação das telas de grades de disciplinas. Além disso, o time de DevOps também iria auxiliar o time de back-end na implementação do sistema de logout de sessão do Google OAuth. Por fim, o time de front-end ficou responsável pela atualização da tela de grades de disciplinas. + +## Finalização + +No final da _Sprint_, o time conseguiu realizar, de maneira satisfatória, várias das tarefas propostas. Porém, tendo em vista a prioridade de ajustar erros encontrados na implementação das telas, o back-end precisou adiar a implementação da criação de grades. + +Os resultados obtidos foram: + +- Implementação do sistema de logout de sessão do Google OAuth +- Melhora na experiência do usuário ao realizar buscas com melhor eficiência +- Criação da API que retorna os períodos disponíveis para criação de grade + +**Observações:** + +As alterações, apesar de não serem as esperadas, foram de grande significância para o projeto. Portanto, o time decidiu manter as alterações realizadas e adiar a implementação da criação de grades para a próxima _Sprint_. diff --git a/docs/sprints/sprint-11.md b/docs/sprints/sprint-11.md new file mode 100644 index 00000000..b5a9a0ff --- /dev/null +++ b/docs/sprints/sprint-11.md @@ -0,0 +1,41 @@ +# Sprint 11 + +Período: 22/11/2023 a 29/11/2023 + +## Descrição + +Nessa _Sprint_, o time se reuniu para discutir sobre as tarefas que seriam realizadas. + +Para o back-end, houve o ajuste dos erros do web-scraping em relação à coleta de carga horária múltipla de disciplinas e adequar o sistema para receber também datas especiais (validade de cada código de carga horária). Associado ao web-scraping, é necessário também o ajuste desses dados no banco de dados. + +Já para o front-end, houve a criação da tela de seleção de matérias e a criação da tela de pesquisa de matérias. + +Para o DevOps, houve a realocação dos membros para ajudar e auxiliar nas demais tarefas. + +Outra decisão importante foi a definição do site do projeto, que será o [SuaGradeUnB](https://suagradeunb.com.br). + +## Objetivos + +- Ajustar o web-scraping para coletar carga horária múltipla de disciplinas +- Ajustar o web-scraping para coletar datas especiais (validade de cada código de carga horária) +- Ajustar o banco de dados para receber os dados coletados pelo web-scraping +- Criar a tela de seleção de matérias +- Criar a tela de pesquisa de matérias + +## Reuniões + +### Reunião 1 + +Data: 22/11/2023 + +Local: Gather Town + +**Ata:** + +Nessa reunião, o time se juntou para discutir sobre as tarefas que seriam realizadas durante a Sprint. Bem como para definir o site oficial do projeto, que será o [SuaGradeUnB](https://suagradeunb.com.br). Portanto foi definido que o time de DevOps iria auxiliar o time de front-end na implementação das telas de seleção e pesquisa de matérias. Além disso, o time de DevOps também iria auxiliar o time de back-end na implementação do web-scraping e no ajuste do banco de dados. Por fim, o time de front-end ficou responsável pela implementação das telas de seleção e pesquisa de matérias. + +## Finalização + +Para esta _Sprint_, o time conseguiu entregar todas as tarefas propostas com sucesso. + +Algumas tarefas extras também foram realizadas, como a atualização do README do projeto. \ No newline at end of file diff --git a/docs/sprints/sprint-2.md b/docs/sprints/sprint-2.md index f07e8e17..183ec63d 100644 --- a/docs/sprints/sprint-2.md +++ b/docs/sprints/sprint-2.md @@ -23,7 +23,7 @@ Local: Gather Town **Ata:** -Nessa reunião o time de DevOps apresentou a base do CI/CD do projeto implementado e entregou para o time Back-end o ambiente de desenvolvimento da API preparado com a utilização do Docker. Além disso, o time de Design/Front-end apresentou a paleta de cores, logo escolhidas para o projeto e uma pequena ideia da tipografia que será utilizada. +Nessa reunião o time de DevOps apresentou a base do CI/CD do projeto implementado, e entregou para o time Back-end o ambiente de desenvolvimento da API, preparado com a utilização do Docker. Além disso, o time de Design/Front-end apresentou a paleta de cores, logo escolhidas para o projeto e uma pequena ideia da tipografia que será utilizada. ## Finalização @@ -33,4 +33,4 @@ O time de DevOps não conseguiu finalizar a implementação do Codecov no GitHub **Observações:** -Para a próxima _Sprint_ o time de DevOps irá entrar em contato com os proprietários da organização [@unb-mds](https://github.com/unb-mds) para instalar o aplicativo do Codecov. +Para a próxima _Sprint_ o time de DevOps irá entrar em contato com os proprietários da organização [@unb-mds](https://github.com/unb-mds), para solicitar-lhe a instalação do aplicativo Codecov. diff --git a/docs/sprints/sprint-3.md b/docs/sprints/sprint-3.md index 9edaeb39..b4e392c7 100644 --- a/docs/sprints/sprint-3.md +++ b/docs/sprints/sprint-3.md @@ -24,7 +24,7 @@ Local: Gather Town **Ata:** -Nessa reunião, o time _DevOps_ e _Back-end_ apresentou o protótipo da arquitetura do projeto e o time de back-end apresentou as bibliotecas escolhidas para _web-scraping_ e montagem de grade. Além disso, o time decidiu, juntamente com a professora que não haverá desenvolvimento mobile, apenas web, ou seja, o _Front-end_ irá utilizar o _Next.js_ para o desenvolvimento da e no lugar do _Amazon SQS_ para fila e do _EC2 AWS_ para deploy vamos utilizar o _Redis_ com _Heroku_ para subir nossa aplicação no ar. Logo, nossa arquitetura ficou da seguinte forma: +Nessa reunião, o time _DevOps_ e _Back-end_ apresentou o protótipo da arquitetura do projeto e o time de back-end apresentou as bibliotecas escolhidas para _web-scraping_ e montagem de grade. Além disso, o time decidiu, juntamente com a professora que não haverá desenvolvimento mobile, portanto, o projeto é apenas web, ou seja, o _Front-end_ irá utilizar o _Next.js_ para o desenvolvimento, e no lugar do _Amazon SQS_ para fila e do _EC2 AWS_ para deploy vamos utilizar o _Redis_ com _Heroku_ para subir o referido site. Logo, nossa arquitetura ficou da seguinte forma: - Design: Figma - Framework: Next.js @@ -51,4 +51,4 @@ O time de DevOps não conseguiu finalizar a implementação do Codecov no GitHub **Observações:** -Para a próxima _Sprint_ o time de DevOps irá entrar em contato com os proprietários da organização [@unb-mds](https://github.com/unb-mds) conseguir o token do _Codecov_. +Para a próxima _Sprint_ o time de DevOps entrará em contato com os proprietários da organização [@unb-mds](https://github.com/unb-mds), para que seja fornecido o token do _Codecov_. diff --git a/docs/sprints/sprint-4.md b/docs/sprints/sprint-4.md index 0642c9f8..e7322efa 100644 --- a/docs/sprints/sprint-4.md +++ b/docs/sprints/sprint-4.md @@ -4,11 +4,11 @@ Período: 04/10/2023 a 11/10/2023 ## Descrição -Nessa _Sprint_ o time definiu algumas tarefas importantes para realizar na semana. Para o back-end, há o início da definição das rotas de acesso da API, a integração do _Google OAuth_ na autenticação do projeto e criação do protótipo do _web-scraping_. +Nessa _Sprint_ foram definidas importantes tarefas a serem realizadas durante a semana. Para o back-end, há o início da definição das rotas de acesso da API, a integração do _Google OAuth_ na autenticação do projeto e criação do protótipo do _web-scraping_. Para o front-end, o início do protótipo de alta fidelidade através da plataforma _Figma_. -Para o DevOps, a busca pelo _CODECOV_TOKEN_ e integrar os testes, inicialização e preparo do ambiente do _front-end_. Também envolve a pesquisa sobre a plataforma _Heroku_ para hospedagem da API do projeto. +Para o DevOps, a busca pelo _CODECOV_TOKEN_ e integração dos testes, inicialização e preparo do ambiente do _front-end_. Também envolve a pesquisa sobre a plataforma _Heroku_ para hospedagem da API do projeto. ## Objetivos @@ -18,7 +18,7 @@ Para o DevOps, a busca pelo _CODECOV_TOKEN_ e integrar os testes, inicializaçã - Iniciar protótipo de alta fidelidade - Buscar _CODECOV_TOKEN_ - Integrar testes -- inicialização e preparo do ambiente do _front-end_ +- Inicialização e preparo do ambiente do _front-end_ - Pesquisar sobre a plataforma _Heroku_ para hospedagem da API do projeto ## Reuniões diff --git a/docs/sprints/sprint-5.md b/docs/sprints/sprint-5.md index 29a96317..5955c7a9 100644 --- a/docs/sprints/sprint-5.md +++ b/docs/sprints/sprint-5.md @@ -4,7 +4,7 @@ Período: 11/10/2023 a 18/10/2023 ## Descrição -Nessa _Sprint_ o time de _Back-end_ ficou responsável por finalizar e arrumar a definição as rotas da API apresentando uma documentação do que é esperado de funcionalidades da aplicação. O time de _Front-end_ e design estava responsável por continuar a produção do protótipo de alta fidelidade, utilizando a ferramenta Figma. Já o time de _DevOpd_ ficou encarregado de tentar contato com os proprietários da organização [@unb-mds](https://github.com/unb-mds) para conseguir o token do _Codecov_ e assim finalizar a implementação do _Codecov_ no GitHub Workflow. +Nessa _Sprint_ o time de _Back-end_ ficou responsável por finalizar e arrumar a definição as rotas da API, apresentando a documentação do que é esperado das funcionalidades da aplicação. O time _Front-end_ e design estava responsável por continuar a produção do protótipo de alta fidelidade, utilizando a ferramenta Figma. Já o time de _DevOps_ ficou encarregado de tentar contato com os proprietários da organização [@unb-mds](https://github.com/unb-mds) para conseguir o token do _Codecov_ e assim finalizar a implementação do _Codecov_ no GitHub Workflow. ## Objetivos @@ -22,8 +22,8 @@ Local: Gather Town **Ata:** -Nessa reunião, o time do _Front-end_ finalizou a apresentação do [protótipo de alta fidelidade](https://www.figma.com/proto/o5Ffh1fWmmQz7KcDGuHrVP/Sua-grade-UNB?type=design&node-id=16-2775&scaling=scale-down&page-id=0%3A1&mode=design&t=vdtHhHY0NWBuOQwZ-1) do projeto, e o time de _Back-end_ apresentou as [rotas](https://unb-mds.github.io/2023-2-Squad11/api/) da API arrumadas e definidas para todos os escopos do qual o projeto irá precisar. +Nessa reunião, o time do _Front-end_ finalizou a apresentação do [protótipo de alta fidelidade](https://www.figma.com/proto/o5Ffh1fWmmQz7KcDGuHrVP/Sua-grade-UNB?type=design&node-id=16-2775&scaling=scale-down&page-id=0%3A1&mode=design&t=vdtHhHY0NWBuOQwZ-1) do projeto, e o time de _Back-end_ apresentou as [rotas](https://unb-mds.github.io/2023-2-Squad11/api/) da API organizadas e definidas para todos os escopos necessários no projeto. ## Finalização -A _Sprint_ foi finalizada com sucesso pra os times do _Back-end_ e _Front-end_, mas o time de _DevOps_ ainda está em tentativa de conseguir o token do _Codecov_ para finalizar a implementação do _Codecov_ no GitHub Workflow. +A _Sprint_ foi finalizada com sucesso pra os times do _Back-end_ e _Front-end_, no entanto o time _DevOps_ ainda está tentando conseguir o token do _Codecov_, para finalizar a implementação do _Codecov_ no GitHub Workflow. diff --git a/docs/sprints/sprint-6.md b/docs/sprints/sprint-6.md index f7187bde..5179fc74 100644 --- a/docs/sprints/sprint-6.md +++ b/docs/sprints/sprint-6.md @@ -4,7 +4,7 @@ Período: 18/10/2023 a 25/10/2023 ## Descrição -Nessa _Sprint_ o time de _Back-end_ ficou responsável por iniciar os testes para autenticação do projeto. Para o time _Front-end_, foi definido que o time ficaria responsável por desenvolver documentação para o projeto desenvolvido por eles. Já o time de _DevOps_ ficou encarregado de finalizar a implementação do _Codecov_ no GitHub Workflow e aprenser sobre deploy no Heroku com Redis e PostgreSQL. +Nessa _Sprint_ o time de _Back-end_ ficou responsável por iniciar os testes para autenticação do projeto, bem como testar as funcionalidades já implementadas seja do _web-scraping_, seja do _Google OAuth_. Para o time _Front-end_, foi definido que o time ficaria responsável por desenvolver a documentação do projeto por eles desenvolvido. Já o time _DevOps_ ficou encarregado de finalizar a implementação do _Codecov_ no GitHub Workflow, e estudar sobre deploy no Heroku com Redis e PostgreSQL. ## Objetivos diff --git a/docs/sprints/sprint-8.md b/docs/sprints/sprint-8.md index 1651f64a..74132fd5 100644 --- a/docs/sprints/sprint-8.md +++ b/docs/sprints/sprint-8.md @@ -4,7 +4,7 @@ Período: 01/11/2023 a 07/11/2023 ## Descrição -Nessa _Sprint_, o time definiu algumas tarefas importantes para começar a segunda etapa do projeto. Portanto, as tarefas foram divididas entre os times de acordo com a necessidade e ocupação de cada membro, desconsiderando cada *função* como *DevOps*, *Front-end* e *Back-end*. Além disso, foi decidido que o uso do *Celery*, *Redis* e *Kubernetes* seriam, a princípio, descartados, uma vez que a organizadora do projeto deu a sugestão por conta da preocupação com o tempo. +Nessa _Sprint_, o time definiu algumas tarefas importantes para começar a segunda etapa do projeto. Portanto, as tarefas foram divididas entre os times de acordo com a necessidade e ocupação de cada membro, desconsiderando cada *função* como *DevOps*, *Front-end* e *Back-end*. Além disso, foi decidido que o uso do *Celery*, *Redis* e *Kubernetes* seriam, a princípio, descartados, uma vez que a organizadora do projeto deu essa sugestão, baseada no pouco tempo disponivel para desenevolvimento do projeto. ## Objetivos @@ -24,10 +24,10 @@ Local: Gather Town **Ata:** -Nessa reunião, o time se juntou para definir as tarefas que seriam realizadas durante a _Sprint_. Além disso, foi decidido que o uso do *Celery*, *Redis* e *Kubernetes* seriam, a princípio, descartados, uma vez que a organizadora do projeto deu a sugestão por conta da preocupação com o tempo e *overhead* que essas ferramentas poderiam trazer. +Nessa reunião, o time se juntou para definir as tarefas que seriam realizadas durante a _Sprint_. Além disso, foi decidido que o uso do *Celery*, *Redis* e *Kubernetes* seriam, a princípio, descartados, uma vez que a organizadora do projeto deu a sugestão, baseada na preocupação com o tempo e *overhead* que essas ferramentas poderiam trazer. ## Finalização A _Sprint_ foi finalizada com algumas tarefas postergadas. Por conta da baixa experiência do time com o uso de React e linguagens de marcação, a implementação da tela de login foi postergada para a pŕoxima _Sprint_. No caso, esta ficou definida para estudos. -Já no caso da implementação da pesquisa de disciplinas por tempo de busca através de uma API, também foi postergada por conta que o time teve que focar na implementação dos testes do projeto, uma vez que o Codecov tinha sido implementado na _Sprint_ anterior. \ No newline at end of file +Já no caso da implementação da pesquisa de disciplinas, por tempo de busca através de uma API, esta também foi postergada, tendo em vista a necessidade de enfoque na implementação dos testes do projeto, uma vez que o Codecov tinha sido implementado na _Sprint_ anterior. \ No newline at end of file diff --git a/docs/sprints/sprint-9.md b/docs/sprints/sprint-9.md index cdd0e4e0..76912248 100644 --- a/docs/sprints/sprint-9.md +++ b/docs/sprints/sprint-9.md @@ -4,9 +4,9 @@ Período: 08/11/2023 a 15/11/2023 ## Descrição -Nessa _Sprint_, o time definiu algumas metas importantes. Portanto, as tarefas foram divididas entre os times, considerando um objetivo entregável para cada um. Portanto, para o back-end, houve a criação da API de busca por matéria e seus respectivos testes. A criação de uma matéria envolvia o uso de funções e/ou algoritmos eficientes que garantiam uma busca satisfatória para uma boa experiência de usuário. +Nessa _Sprint_, o time definiu algumas metas importantes. Portanto, as tarefas foram divididas entre os times, considerando um objetivo um tanto mais palpável para cada um. Portanto, para o back-end, houve a criação da API de busca por matérias e seus respectivos testes. A criação de uma matéria envolvia o uso de funções e/ou algoritmos eficientes, que garantiam uma busca satisfatória para uma boa experiência de usuário. -Já para o front-end, houve a criação da tela de registro e de confirmação de login. Além disso, pensando na acessibilidade, houve a discussão sobre fazer um código com textos alternativos para pessoas com deficiência visual. Adicionalmente, por sugestão da organizadora do projeto, houve também a definição de cores mais legíveis independente da tela do usuário, pensando também naqueles que possuem daltonismo. +Já para o time front-end, houve a criação da tela de registro e de confirmação de login. Além disso, pensando na acessibilidade, houve a discussão sobre fazer um código com textos alternativos para pessoas com deficiência visual. Adicionalmente, por sugestão da organizadora do projeto, houve também a definição de cores mais legíveis independente da tela do usuário, pensando também naqueles que possuem daltonismo. Já para o DevOps, as suas metas foram realocadas para as outras áreas do projeto, pensando em uma melhor distribuição de tarefas e mais agilidade na entrega de resultados. @@ -29,7 +29,7 @@ Local: Gather Town **Ata:** -Nessa reunião, o time se juntou para discutir sobre as tarefas que seriam realizadas durante a _Sprint_. +Nessa reunião, o time se juntou para discutir sobre as tarefas que seriam realizadas durante a _Sprint_. Portanto foi definido que o time de DevOps iria auxiliar o time de front-end na implementação de textos alternativos para pessoas com deficiência visual. Além disso, o time de DevOps também iria auxiliar o time de back-end na implementação da API de busca por matérias e seus respectivos testes. Por fim, o time de front-end ficou responsável pela implementação da tela de registro e de confirmação de login, além de definir cores mais legíveis independente da tela do usuário. ## Finalização diff --git a/mkdocs.yml b/mkdocs.yml index 849c0a74..47d5c889 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -6,17 +6,19 @@ nav: - Como contribuir?: contributing.md - Como executar o projeto?: executing.md - Sprints: - - Sprint 0: sprints/sprint-0.md - - Sprint 1: sprints/sprint-1.md - - Sprint 2: sprints/sprint-2.md - - Sprint 3: sprints/sprint-3.md - - Sprint 4: sprints/sprint-4.md - - Sprint 5: sprints/sprint-5.md - - Sprint 6: sprints/sprint-6.md - - Sprint 7: sprints/sprint-7.md - - Sprint 8: sprints/sprint-8.md - - Sprint 9: sprints/sprint-9.md - + - Sprint 0: sprints/sprint-0.md + - Sprint 1: sprints/sprint-1.md + - Sprint 2: sprints/sprint-2.md + - Sprint 3: sprints/sprint-3.md + - Sprint 4: sprints/sprint-4.md + - Sprint 5: sprints/sprint-5.md + - Sprint 6: sprints/sprint-6.md + - Sprint 7: sprints/sprint-7.md + - Sprint 8: sprints/sprint-8.md + - Sprint 9: sprints/sprint-9.md + - Sprint 10: sprints/sprint-10.md + - Sprint 11: sprints/sprint-11.md + - Front-end: - Semana 0: frontend/semana-0.md - Semana 1: frontend/semana-1.md