Merge pull request #26 from FGA0138-MDS-Ajax/homol

Sprint 01 de Homol para produção.

docs/sprints/criar_arquivos_sprint.py

@@ -0,0 +1,131 @@
+import os
+import sys
+
+
+def exibir_mensagem_erro():
+    """
+    Exibir mensagem de erro e fechar o programa.
+    Chamada quando o usuário não coloca a entrada correta.
+    """
+    print("Erro no uso do script.")
+    print("Uso correto: python3 criar_arquivos_sprint.py <numero da sprint>")
+    print("<numero da sprint> deve ser um número natural.\n")
+
+    sys.exit(1)
+
+
+class CriadoraArquivos:
+    """
+    Classe para criar arquivos de template.
+    """
+
+    def __init__(self):
+        self.numero_sprint = self.tratar_entrada()
+        self.path = self.criar_diretorio()
+
+    def tratar_entrada(self) -> int:
+        """
+        Tratar a entrada por linha de comando.
+        Caso o uso do programa seja correto, retorna o número da sprint.
+        """
+        tam_params = len(sys.argv)
+
+        if tam_params != 2:
+            exibir_mensagem_erro()
+
+        # converter entrada para inteiro
+        try:
+            numero_sprint = int(sys.argv[1])
+
+            if numero_sprint <= 0:
+                raise ValueError
+
+            return numero_sprint
+
+        except ValueError:
+            exibir_mensagem_erro()
+
+    def criar_diretorio(self) -> str:
+        """
+        Criar o diretório da sprint.
+        Retorna ele ou fecha o programa caso ocorra algum erro.
+        """
+        dir = f'./sprint-{self.numero_sprint}'
+        try:
+            os.mkdir(dir)
+            return dir
+        except Exception:
+            print("Erro ao criar diretório")
+            sys.exit(1)
+
+    def criar_arquivo(self, nome_arquivo: str, conteudo_arquivo: str):
+        """
+        Criar um arquivo qualquer no diretório criado.
+
+        :param nome_arquivo: nome do arquivo a ser criado.
+        :param conteudo_arquivo: conteúdo do arquivo a ser criado.
+        """
+
+        nome_arquivo = f's{self.numero_sprint}-{nome_arquivo}.md'
+
+        try:
+            arquivo = open(os.path.join(self.path, nome_arquivo), "a")
+            arquivo.write(conteudo_arquivo)
+            arquivo.close()
+
+        except Exception:
+            print(f"Erro ao criar {nome_arquivo}")
+            sys.exit(1)
+
+
+if __name__ == "__main__":
+
+    criadora = CriadoraArquivos()
+
+    params = []
+
+    # criar parametros pro arquivo de dailies
+    template_dailies = ''
+    index = 0
+
+    while index < 3:
+        template_dailies += '## Daily dd/mm/aaaa\n'
+        for name in [
+                'Fábio',
+                'João Eduardo',
+                'João Pedro',
+                'Lucas Queiroz',
+                'Lucas Meireles',
+                'Philipe',
+                'Rodrigo'
+        ]:
+            template_dailies += f'### {name}\n'
+            template_dailies += '- O que fiz ontem?\n- O que pretendo fazer hoje?\n- Existe algo que está me atrapalhando?'
+            template_dailies += '\n\n'
+        index += 1
+
+    # criar parametros pro arquivo de planning
+    template_planning = "## Sprint backlog" + 5 * '\n'
+    template_planning += "## Meta da sprint" + 5 * '\n'
+    template_planning += "## Bibliografia \n"
+    template_planning += 'SCHWABER, Ken; SUTHERLAND, Jeff. **Guia do Scrum:** as regras do jogo. 2ª ed. Rio de Janeiro: Elsevier, 2020.\n'
+
+    # criar parametros pro arquivo de retrospective
+    template_review_retrospective = "## Review\n"
+    template_review_retrospective += "### A meta da sprint foi atingida?\n\n"
+    template_review_retrospective += "### As histórias de usuário propostas foram entregues?\n\n"
+    template_review_retrospective += '\n\n'
+    template_review_retrospective += "## Retrospective\n"
+    template_review_retrospective += "### Quais foram as principais dificuldades durante a sprint?\n"
+    template_review_retrospective += "### A equipe realizou as atividades definidas?\n"
+    template_review_retrospective += "### A equipe teve alguma dificuldade técnica?\n"
+    template_review_retrospective += "### Como a equipe entende que pode melhorar para a próxima sprint?\n"
+    template_review_retrospective += "### O que a equipe entendeu que fez de bom e pode refazer para a próxima sprint?\n"
+    template_review_retrospective += '\n\n## Métricas'
+
+    params.append(('review-retrospective', template_review_retrospective))
+    params.append(('dailies', template_dailies))
+    params.append(('planning', template_planning))
+
+    for param in params:
+        criadora.criar_arquivo(param[0], param[1])

docs/sprints/sprint-1/s1-dailies.md

@@ -0,0 +1,142 @@
+## Daily 26/10/2023
+### Fábio
+- O que fiz ontem? **Participei do planning**
+- O que pretendo fazer hoje?**Começar o estudo da us1**
+- Existe algo que está me atrapalhando?**Organização com as demais matérias**
+
+### João Eduardo
+- O que fiz ontem? **Participei no planning**
+- O que pretendo fazer hoje? **Estudar sobre como subir um banco mysql para uso e tentar fazer o código para recebimento do arquivo csv**
+- Existe algo que está me atrapalhando? **Falta de familiaridade com as tecnologias escolhidas**
+
+### João Pedro
+- O que fiz ontem? **Participei do planning**
+- O que pretendo fazer hoje? **Estudar como fazer a api receber o arquivo csv**
+- Existe algo que está me atrapalhando? **falta de tempo devido à demandas acadêmicas**
+
+### Lucas Queiroz
+- O que fiz ontem? **Participei no planning**
+- O que pretendo fazer hoje? **Criar template  de issues para US, estudar o express, tentar subir container docker com dependências do backend**
+- Existe algo que está me atrapalhando? **Responsabilidades da vida pessoal**
+
+### Lucas Meireles (não participou)
+### Philipe
+- O que fiz ontem? **Comecei o processo de prototipagem da UI**
+- O que pretendo fazer hoje? **Trabalhar na padronização dos ambientes(dev, homolog, prod) e continuar a prototipagem da UI**
+- Existe algo que está me atrapalhando?**Falta de tempo**
+
+### Rodrigo
+- O que fiz ontem? **Participei do planning**
+- O que pretendo fazer hoje? **estudar como fazer a api receber um arquivo csv, como subir o banco mysql e as tecnologias do backend**
+- Existe algo que está me atrapalhando? **falta de tempo e familiaridade com as linguagens**
+
+
+
+## Daily 27/10/2023
+
+### Fábio
+
+- O que fiz ontem? **Iniciei o estudo no front da us1**
+- O que pretendo fazer hoje?**Continuar o estudo e começar a ver sobre arquitetura**
+- Existe algo que está me atrapalhando?**Conciliar com as demais matérias e atividades fora da universidade**
+
+### João Eduardo
+
+- O que fiz ontem? **estudei como proceder para recebimento do arquivo .csv e alguns passos a passos para subir o banco **
+- O que pretendo fazer hoje? **continuar o estudo do banco e do recebimento do arquivo .csv**
+- Existe algo que está me atrapalhando? **falta de tempo por demanda do trabalho**
+
+### João Pedro
+
+- O que fiz ontem? **estudei como fazer a API receber o arquivo.csv**
+- O que pretendo fazer hoje? **continuar o estudo de como fazer fazer a API receber o arquivo .csv**
+- Existe algo que está me atrapalhando? **falta de tempo por conta de outras matérias**
+
+### Lucas Queiroz
+
+- O que fiz ontem? **Criei várias templates de issues para US e tasks genéricas, terminei as issues #9 e #16 e estudei express**
+- O que pretendo fazer hoje? **Dar uma olhada no documento de arquitetura, tentar iniciar se possível**
+- Existe algo que está me atrapalhando? **Responsabilidades da vida pessoal e acadêmica**
+
+### Lucas Meireles
+
+- O que fiz ontem? **Resolvi problemas de outras matérias e revisei aspectos internos do produto com outro representante**
+- O que pretendo fazer hoje? **Finalizar revisões internas do impacto do produto e itens de valor de mercado para garantir critérios de aceitação mais claros,  retomar pesquisas sobre as tecnologias utilizadas e revisar alterações já feitar no github**
+- Existe algo que está me atrapalhando? **Aguardando contato de empresas para finalizar uma pendência que vem desde segunda**
+
+### Philipe
+
+- O que fiz ontem? **Ontem foi corrido, não consegui resolver nada, até então**
+- O que pretendo fazer hoje? **Subir as containerizações para liberar os ambientes, organizar o quadro kanban e avançar com a prototipagem de UI**
+- Existe algo que está me atrapalhando?**Exigência técnica de criação do Projeto para andarmos com o quadro Kanban ligado juntamento com as issues e todo o repositório**
+
+### Rodrigo
+
+- O que fiz ontem? **estudei um pouco o NodeJS**
+- O que pretendo fazer hoje? **continuar o estudo do NodeJS, se der tempo começar a estudar como fazer fazer a API receber o arquivo.csv**
+- Existe algo que está me atrapalhando? **falta de tempo por conta de outras matérias**
+
+
+
+
+
+## Daily 30/10/2023 (referente ao final de semana)
+### Fábio (não participou)
+
+### João Eduardo (não participou)
+
+### João Pedro (não participou)
+
+### Lucas Queiroz
+
+- O que fiz no final de semana? **Nada no final de semana, mas na sexta-feira trabalhei no documento de arquitetura.**
+- O que pretendo fazer hoje? **Ajudar na elaboração do doc de arquitetura, organizar e documentar a review e a retrospective e documentar os dados da sprint atual.**
+- Existe algo que está me atrapalhando? **Não.**
+
+### Lucas Meireles (não participou)
+
+### Philipe
+
+- O que fiz no final de semana? **Avancei um pouco com o protótipo da home page.**
+- O que pretendo fazer hoje? **Ajudar na elaboração do doc de arquitetura, realizar a estruturação dos ambientes e organizar o kanban flow.**
+- Existe algo que está me atrapalhando?**Tecnicamente não, falta um pouco de criatividade para pensar no restante do design, mas irei pensar em algo.**
+
+### Rodrigo (não participou)
+
+
+
+## Daily 31/10/2023
+
+### Fábio (não participou)
+
+### João Eduardo (não participou)
+
+### João Pedro 
+
+- O que fiz ontem? **Ajudei no documento de arquitetura.**
+- O que pretendo fazer hoje? **Ajudar a equipe a terminar o doc de arquitetura**
+- Existe algo que está me atrapalhando? **Concorrência com outras matérias**
+
+### Lucas Queiroz
+
+- O que fiz ontem? **Ajudei no documento de arquitetura e documentei alguns dados da sprint 1**
+- O que pretendo fazer hoje? **Ajudar a equipe a terminar o doc de arquitetura e revisar o PR do Philipe**
+- Existe algo que está me atrapalhando? **Concorrência com outras matérias**
+
+### Lucas Meireles 
+
+- O que fiz ontem? **Iniciado tarefas do documento de arquitetura**
+- O que pretendo fazer hoje? **Estudos de tecnologias, maior detalhamento de backlog e finalizar documento de arquitetura**
+- Existe algo que está me atrapalhando? **Problemas em casa e de serviço**
+
+### Philipe
+
+- O que fiz ontem? **Terminei a task de criar um template para as PRs, editei alguns templates issues para melhorar a qualidade, terminei a task de organizar o kanban board do github, abri um PR para enviar a estrutura do backend para a main e trabalhei na conteinerização da aplicação do backend e do banco de dados.**
+- O que pretendo fazer hoje? **Ajudar a equipe a terminar o documento de arquitetura e testar a conteinerização em outra máquina.**
+- Existe algo que está me atrapalhando? **Pequena falta de tempo, por causa de outras matérias/trabalho.**
+
+
+### Rodrigo 
+- O que fiz ontem? **Ajudei no documento de arquitetura.**
+- O que pretendo fazer hoje? **Ajudar a equipe a terminar o doc de arquitetura e estudar um pouco as tecnologias do backend.**
+- Existe algo que está me atrapalhando? **Falta de tempo por causa de problemas pessoais.**

docs/sprints/sprint-1/s1-planning.md

@@ -0,0 +1,8 @@
+## Sprint backlog
+Nessa sprint, a US1 foi o único item a ser colocado no backlog da sprint.
+
+## Meta da sprint
+A meta da sprint é terminar o documento de arquitetura e entregar a US1. 
+
+## Bibliografia 
+SCHWABER, Ken; SUTHERLAND, Jeff. **Guia do Scrum:** as regras do jogo. 2ª ed. Rio de Janeiro: Elsevier, 2020.

docs/sprints/sprint-1/s1-review-retrospective.md

@@ -0,0 +1,38 @@
+## Review
+### A meta da sprint foi atingida?
+
+Não, a meta da sprint não foi atingida. Entregamos o documento de arquitetura, mas não entregamos a US1.
+
+### As histórias de usuário propostas foram entregues?
+
+Não, a US1 não foi entregue. No tocante à aplicação, apenas conseguimos subir os contêineres docker.
+
+## Retrospective
+### Quais foram as principais dificuldades durante a sprint?
+
+Alguns membros da equipe tiveram empecilhos pessoais e acadêmicos, de forma que não conseguiram se dedicar ao projeto como gostariam. Além disso, o documento de arquitetura mudou o foco da sprint. Por isso, deixamos de lado a US1 para focar totalmente na entrega do documento da melhor maneira possível.
+
+### A equipe realizou as atividades definidas?
+
+A equipe realizou a Sprint Planning, definindo uma meta e histórias de usuário a serem entregues. As dailies foram realizadas, mas, em algumas delas, poucos membros participaram.
+
+### A equipe teve alguma dificuldade técnica?
+
+Sim, a equipe teve várias dificuldades técnicas. Alguns membros tiraram tempo especial para estudar as tecnologias e remover esses obstáculos, mas surgiram outros, como a contêinerização utilizando docker. Estes consumiram tempo considerável da sprint para serem resolvidos.
+
+### Como a equipe entende que pode melhorar para a próxima sprint?
+
+- A equipe (em especial o Scrum Master) deve ser mais organizada na delegação de tarefas. Um problema dessa sprint foi de definir quem deveria fazer qual atividade. A partir do momento que percebemos isso e corrigimos, o projeto andou mais rapidamente. 
+- Os membros devem se esforçar em participar de todas as dailies. Em um dia, apenas dois membros participaram da daily. Isso atrapalha muito os processos de transparência, inspeção e adaptação, que são pilares do Scrum.
+- Os membros devem ser mais organizados para cumprir o que definiram nas dailies. Alguns membros falaram que iam fazer uma coisa, mas acabavam fazendo outra coisa diferente ou não faziam nenhuma.
+- Os membros devem ser mais ativos no desenvolvimento das histórias de usuário propostas. No entanto, essa observação deve ser lida com reservas, pois além da história de usuário, tivemos que lidar com o documento de arquitetura.
+
+### O que a equipe entendeu que fez de bom e pode refazer para a próxima sprint?
+
+- A equipe teve uma boa reunião de planejamento. Conseguimos, como um grupo, entender bem as necessidades da US1 e entender o passo-a-passo para entregá-la.
+- Alguns membros foram assíduos nas dailies, participando de todas.
+- A equipe como um todo trabalhou bem no desenvolvimento do documento de arquitetura.
+- O PO entende que conseguiu explicar os requisitos e minar dúvidas referentes ao produto de maneira contínua.
+- Por mais que não tenha sido perfeito, ou até de acordo com nossas expectativas, a equipe entende que conseguiu fazer bem aquilo que era mais emergente, i.e., o documento de arquitetura.
+
+## Métricas