Giter Club home page Giter Club logo

2020.2-projeto-kokama-wiki's Introduction

Kokama Kinkin

Kokama Kinkin

Rode a Wiki com Docker

Para executar localmente a aplicação, proceda com os seguintes passos:

  1. Instale o Docker neste link;
  2. Instale o Docker Compose neste link;
  3. Na pasta raiz do projeto, inicialize a wiki com a documentação do projeto: sudo docker-compose up --build;
  4. Acesso a wiki no navegador: http://localhost:8008/.

Deploy: realizado com GitHub Actions a partir da branch main.

2020.2-projeto-kokama-wiki's People

Contributors

aluzianobriceno avatar andrelucax avatar laispa avatar leomedeiros1 avatar lievertom avatar luisgaboardi avatar nickby2 avatar sfernandos avatar welisonr avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

2020.2-projeto-kokama-wiki's Issues

Estudo sobre metodologias ágeis

Descrição

Issue criada com a finalidade de difundir conceitos e valores de metodologias ágeis através de materiais de estudo. Tópicos para estudo: Scrum, Extreme Programming, Kanban.

Tarefas

  • Estudar material anexo e outras fontes na área de metodologia ágil;
  • Realizar pequeno teste com questões diversificadas sobre metodologias ágeis. (Link)

Critérios de Aceitação

  • Todos os membros de MDS responder o pequeno teste sobre metodologias ágeis.

Recomendação de leitura

Já estudou os tópicos acima?

  • Ana
  • Fernando
  • Lais
  • Lucas
  • Luís Guilherme
  • Luiz Gustavo

Documentar planejamento da sprint 1

Descrição

Issue destinada a documentar o planejamento da sprint 1 na wiki

Tarefas

  • Documentar atividades desenvolvidas;
  • Documentar papéis desempenhos por membros da equipe;
  • Documentar pareamentos.

Critérios de Aceitação

  • Documentar na wiki

Criar documento de código de conduta

Descrição

Criar documento com instruções sobre as condutas que devem ser observadas dentro desse repositório.

Tarefas

  • Criar código de conduta.

Critérios de aceitação

  • Documento com código de conduta criado no repositório.

Aplicar identidade visual na wiki

Descrição

A presente issue tem o objetivo de aplicar a identidade visual, definida em outra issue, na wiki do projeto.

Tarefas

  • Adicionar logo e nome do projeto, conforme exemplo 1. Observação: já existe o código (está comentado), seria gerar a imagem e substituir o link.
  • Adicionar logo e nome do projeto na navbar da landing page (deve estar bem visível);
  • Atualizar papel dos membros de EPS na landing page;
  • Aplicar na landing page as cores definidas na identidade visual ;
  • Adicionar logo, nome e descrição do projeto em todos os atributos aplicáveis no arquivo mkdocs.yml;
  • Alterar cores do mkdocs-material de acordo com a identidade visual;
  • Outras personalizações (opcional).

Critérios de Aceitação

  • Seguir identidade visual da aplicação.

Observações

Exemplo 1

Exemplo - mia ajuda

Documentar revisão e retrospectiva da sprint 1

Descrição

Documentar na wiki a revisão e a retrospectiva da sprint 1 com todos os levantamentos e avaliações realizados, além de documentar as tarefas desenvolvidas durante o período da sprint.

Tarefas

  • Adicionar considerações do Scrum Master;
  • Adicionar métricas;
  • Elencar pontos de melhoria.

Critérios de Aceitação ?

  • Documentar na wiki.

Documentar protótipo de média fidelidade

Descrição

Documentar os protótipos desenvolvidos pela equipe junto com a validacao do PO a respeito dos mesmos

Tarefas

  • Uniao do prototipo de baixa fidelidade (prototipo de media fidelidade)

Critérios de Aceitação

  • Os documentos devem conter o autor
  • Os documentos devem conter a data
  • A validacao do PO deve estar documentada
  • Documentar na wiki

Observações

Os prototipos desenvolvidos pela equipe se encontram no comentario da issue 35

Criar seed das bases de dados do backend

Descrição

Com a finalidade de facilitar a elaboração de código em ambiente de desenvolvimento, essa issue destina-se a criar seeds que funcionem apenas em desenvolvimento a fim de ajudar na criação do backend.

Tarefas

  • No momento em que subir o serviço do docker, caso a aplicação não tenha registros na base de dados, popular cada tabela com alguns registros no microsserviço de tradução.

Critérios de Aceitação

  • Seed só é executada em ambiente de desenvolvimento.
  • Seed não sobrescreve ou repete informações se as tabelas já haviam sido populadas.

Estudo em desenvolvimento frontend

Descrição

Issue destinada a trabalhar conceitos relacionados ao desenvolvimento frontend, com a finalidade de tornar tais conceitos mais fáceis aos membros da equipe para um futuro dojo de react-native.

Tarefas

  • Explorar conceitos básicos de HTML5;
  • Explorar conceitos básicos de CSS;
  • Explorar conceitos básicos de JS.

Critério de Aceitação

Criar primeira versão do backlog do produto

Descrição

Essa issue destina-se a criação da primeira versão do backlog do produto que deverá contar com épicos, features e histórias de usuário.

Tarefas

  • Criar épicos;
  • Criar features;
  • Criar histórias de usuário;
  • Priorizar com a técnica MoSCoW inicialmente.

Critérios de Aceitação

  • Documentar backlog na wiki.

Levantamento de dúvidas sobre o projeto

Descrição

Issue destinada ao levantamento de dúvidas sobre o projeto que será desenvolvido pela equipe. Tais dúvidas serão sanadas em reunião com o PO do projeto.

Tarefas

  • Estudar sobre o povo Kokama;
  • Categorizar dúvida;
  • Anotar dúvida no documento do Google Drive.

Critérios de Aceitação

  • Dúvidas claras e concisas.

Realizar Lean Inception com a equipe

Descrição

Realizar lean inception com a equipe considerando o modelo disponibilizado pela disciplina na plataforma Mural.

Tarefas

  • Explicar aos membros da equipe os tópicos da Lean Inception;
  • Realizar interações de forma a incrementar dados ao modelo de Lean Inception;

Critérios de Aceitação

  • Documentar na wiki.

Dojo de python e programação orientada a objetos

Descrição

Realizar treinamento de python com a equipe a fim de familiarizar o time com a linguagem.

Tarefas

  • Realizar dojo de python;
  • Explicar orientação a objetos em python;
  • Fornecer material de referência para estudo.

Critérios de Aceitação ?

  • Participação de todos os membros de MDS no dojo no canal do discord.

Observações

Materiais úteis:

Definir canais iniciais do projeto

Descrição

Escolher junto a equipe os canais iniciais do projeto em relação a comunicação, organização, documentação etc.

Tarefas

  • Definir canal para comunicação rápida;
  • Definir canal para avisos importantes;
  • Definir canal para trabalho em equipe;
  • Definir canal para criar e compartilhar documentos;
  • Configurar ZenHub (pipeline);
  • Organização inicial do repositório.

Observações

Garantir que todos os membros participem dos canais acima citados.

Documentar reunião com PO (26/02/2021)

Descrição

Documentar principais pontos da reunião realizada em 26/02/2021 com a professora Altaci.

Tarefas

  • Documentar participantes;
  • Documentar pauta da reunião;
  • Documentar principais pontos discutidos.

Critérios de Aceitação

  • Documentar na wiki.

Estudar backend (django)

Descrição

Issue destinada a trabalhar conceitos relacionados a banco de dados e desenvolvimento backend com django, com a finalidade de tornar tais conceitos mais fáceis aos membros da equipe.

Tarefas

  • Explorar a teoria básica de banco de dados (modelagem);
  • Explorar o básico sobre SQL;
  • Explorar sobre conceitos e estrutura de aplicações backend (Django);
  • Explorar CRUD básico em django.

Critérios de Aceitação

  • Utilizar banco de dados relacional postgreSQL.

Documentar revisão e retrospectiva da sprint 2

Descrição

Documentar na wiki a revisão e a retrospectiva da sprint 2 com todos os levantamentos e avaliações realizados, além de documentar as tarefas desenvolvidas durante o período da sprint.

Tarefas

  • Adicionar considerações do Scrum Master;
  • Adicionar métricas;
  • Elencar pontos de melhoria.

Critérios de Aceitação ?

  • Documentar na wiki.

Atualizar README.md

Descrição

Atualizar arquivo README.md com maiores detalhes do projeto.

Tarefas

  • Atualizar arquivo README.md com detalhes sobre o projeto e seus integrantes;
  • Adicionar como subir o ambiente com docker.

Critérios de aceitação

  • Documentar detalhes sobre o projeto;
  • Documentar recursos já disponíveis;
  • Documentar membros da equipe (wiki).

Criar documento de planejamento da sprint 4

Descrição

Issue destinada a documentar o planejamento da sprint 4 na wiki

Tarefas

  • Documentar atividades desenvolvidas;
  • Documentar papéis desempenhos por membros da equipe;
  • Documentar pareamentos.

Critérios de Aceitação

  • Documentar na wiki

Desenvolver primeira versão do Documento de Arquitetura

Descrição

Essa issue tem por objetivo a definição inicial do documento de arquitetura, não necessariamente todos os seus artefatos, de modo a iniciar o pensamento de como seria modelada a solução da aplicação.

Tarefas

  • Conversar com professor sobre os riscos envolvidos na dependência de infraestrutura de terceiros e sobre a definição das tecnologias;
  • Criar primeira versão do documento de arquitetura.

Critérios de Aceitação

  • Documentar na wiki.

Pensar situações, problemas e oportunidades de projeto

Descrição

A presente issue tem por objetivo analisar e escolher com o grupo de MDS e EPS uma situação, problema ou oportunidade de projeto que será desenvolvido pela equipe.

Tarefas

  • Pensar sobre possíveis temas de projeto;
  • Documentar ideias de temas de projeto (público-alvo, problemáticas, possíveis soluções, fontes de dados etc);
  • Documentar riscos relacionados ao projeto.

Observações

  • Basear-se nos super-temas das issues da disciplina: MDS/EPS - Issues;
  • Procurar por fontes de dados que possam ser interessantes a ideia de projeto.

Documentar entrevista com Product Owner

Descrição

Issue destinada a documentar e adicionar à wiki a entrevista realizada com a PO do projeto.

Tarefas

  • Organizar perguntas/tópicos;
  • Adicionar respostas e direcionamentos fornecidos pelo PO.

Critérios de Aceitação

  • Documentar na wiki

Documentar plano de comunicação da equipe

Descrição

Documentar, na wiki, o plano de comunicação da equipe, observado todas as ferramentas e canais utilizados para conversas, pareamentos, reuniões etc.

Tarefas

  • Documentar canais de comunicação instantânea;
  • Documentar canais de comunicação para reuniões;
  • Documentar canais de comunicação para trabalho em equipe.

Critérios de Aceitação

  • Todos os canais de comunicação documentados.

Criar primeira versão do documento de arquitetura

Descrição

Tarefas

  • Conversar com professor sobre os riscos envolvidos na dependência de infraestrutura de terceiros e sobre a definição das tecnologias;
  • Criar primeira versão do documento de arquitetura.

Critérios de Aceitação

  • Documentar na wiki.

Alterar o nome do repositório de documentação

Descrição

Já definido o nome do projeto, essa issue destina-se a atualizar o repositório para constar essa atualização.

Tarefas

  • Alterar nome e descrição do repositório de documentação;
  • Alterar configurações do mkdocs de modo a fazer o build na nova URL.

Critérios de Aceitação

  • Wiki deve funcionar em novo link após as modificações.

Criar landing page para a wiki

Descrição

Criar landing page com a apresentação do projeto, dos membros (EPS e MDS) e dos recursos disponíveis para o usuário navegar (repositórios, wiki).

Tarefas

  • Adicionar imagem ou texto sobre o projeto;
  • Colocar informações dos membros de EPS;
  • Colocar informações dos membros de MDS;
  • Apresentar recursos disponíveis (repositórios).

Observações

  • Salvar foto dos membros na pasta "Integrantes" no Google Drive.

Criar documento de contribuição do repositório

Descrição

Com o objetivo de direcionar a sustentabilidade do repositório, essa issue destina-se a criar um documentação com orientações sobre contribuição ao projeto.

Tarefas

  • Criar documento de contribuição CONTRIBUTING.md.

Observações

  • Verificar templates de projetos da comunidade de software livre.

Adicionar licença do projeto

Descrição

A presente issue se destina a analisar e escolher uma licença para o projeto.

Tarefas

  • Criar documento de licença do projeto.

Criar documento de disponibilidade da equipe

Descrição

Com o objetivo de saber os melhores momentos para a equipe se reunir, essa issue busca elaborar um quadro de disponibilidade dos horários do time.

Tarefas

  • Planilha de disponibilidade da equipe.

Observações

  • A planilha será preenchida por todos os membros.

Criar quadro de conhecimentos da equipe (inicial)

Descrição

Elaborar planilha com quadro de conhecimentos da equipe com o objetivo de entender as áreas de conhecimento de cada membro da equipe.

Tarefas

  • Elaborar planilha com quadro de conhecimentos de programação e gerência.

Observações

  • A planilha será preenchida por todos os membros.

Dojo em desenvolvimento backend

Descrição

Issue destinada a trabalhar conceitos relacionados a banco de dados e desenvolvimento backend, com a finalidade de tornar tais conceitos mais fáceis aos membros da equipe.

Tarefas

  • Explorar a teoria básica de banco de dados (modelagem);
  • Explorar o básico sobre SQL;
  • Explorar sobre conceitos e estrutura de aplicações backend (Django);
  • Explorar CRUD básico em django.

Critérios de Aceitação

  • Utilizar banco de dados relacional postgreSQL.

Definir as tecnologias

Descrição

Definir as tecnologias que serão utilizadas na solução do problema.

Tarefas

  • Definir tecnologias para o backend
  • Definir tecnologias para o frontend
  • Definir banco de dados

Configurar repositório do frontend

Descrição

Iniciada as etapas relacionadas ao desenvolvimento da aplicação, torna-se essencial ter um ambiente estável para que a equipe de desenvolvimento possa trabalhar da melhor maneira possível. Nesse sentido, essa issue destina-se a criar ambientes containerizados a fim de facilitar o processo de desenvolvimento.

Tarefas

  • Avaliar complexidade e necessidade de docker no front;
  • Se aplicável, adicionar serviço da aplicação react native (expo) ao docker-compose;
  • Iniciar uma aplicação padrão expo - react native que suporte typescript.

Critérios de Aceitação

  • Membros da equipe devem conseguir utilizar o ambiente de desenvolvimento construído.

Criar roadmap do produto

Descrição

Issue destinada a criar e adicionar à wiki o roadmap do produto com os principais marcos do desenvolvimento do software.

Tarefas

  • Listar atividades do roadmap do produto;
  • Definir ordem cronológica por sprint das atividades.

Critérios de Aceitação

  • Documentar na wiki.

Criar repositórios do projeto na organização da disciplina

Descrição

Issue destinada a criação dos repositórios do frontend e do backend na organização fga-eps-mds.

Tarefas

  • Criar repositórios dos microsserviços do backend;
  • Criar repositório do frontend.

Critérios de Aceitação

  • Repositórios devem ter sido criados dentro da organização da disciplina;
  • Nome e descrição do repositório coerentes.

Criar protótipo de alta fidelidade

Descrição

Issue destinada a criação de protótipo de alta fidelidade da aplicação Kokama Tradutor, observadas as restrições de design definidas no documento de identidade visual.

Tarefas

  • Criar telas do protótipo de alta fidelidade;
  • Adicionar navegação ao protótipo.

Critérios de Aceitação

  • Protótipo deve estar disponível online através de link;

  • Protótipo deve ser compartilhável a fim de realizar o teste de usabilidade com a professora Altaci na próxima reunião;

  • Protótipo deve observar padrões de design (seja material, ant design ou outros) e observar questões de UI/UX.

  • Documentar na wiki.

Observações

Criar templates de issues, pull requests e outros

Descrição

A presente issue destina-se a criar templates com o objetivo de facilitar a comunicação dentro do repositório.

Tarefas

  • Criar template de Pull Request;
  • Criar template de issues (US);
  • Criar template de issues genérico;
  • [ ] Criar template de bugs;
  • Definir labels do repositório.

Desenvolver primeira versão de rich picture do projeto

Descrição

Desenvolver rich picture com a finalidade de alinhar e expandir pensamentos sobre o projeto

Tarefas

  • Desenvolver rich picture.

Rich Pictures

  • Lucas.
  • Luís.

Critérios de Aceitação

  • Validar ao menos um modelo com a professora Altaci (PO).

Criar documento de planejamento da sprint 2

Descrição

Issue destinada a documentar o planejamento da sprint 2 na wiki

Tarefas

  • Documentar atividades desenvolvidas;
  • Documentar papéis desempenhos por membros da equipe;
  • Documentar pareamentos.

Critérios de Aceitação

  • Documentar na wiki

Realizar teste de usabilidade

Descrição

Realizar teste de usabilidade com a professora Altaci (PO) com o protótipo de alta fidelidade.

Tarefas

  • Escrever os casos de teste;
  • Aplicar teste de usabilidade com a professora Altaci (se possível, outros usuários);
  • Documentar as conclusões relacionadas ao teste.

Critérios de Aceitação

  • Documentar na wiki.

Configurar repositórios do backend

Descrição

Iniciada as etapas relacionadas ao desenvolvimento da aplicação, torna-se essencial ter um ambiente estável para que a equipe de desenvolvimento possa trabalhar da melhor maneira possível. Nesse sentido, essa issue destina-se a criar ambientes containerizados a fim de facilitar o processo de desenvolvimento.

Tarefas

Para cada microsserviço do backend, criar o boilerplate:

  • Adicionar serviço do framework django ao docker-compose;
  • Adicionar serviço de banco de dados postgreSQL ao docker-compose;
  • Iniciar uma aplicação padrão django.

Critérios de Aceitação

  • Membros da equipe devem conseguir utilizar o ambiente de desenvolvimento construído.

Dojo de git e trabalho em equipe

Descrição

Reunião com a participação dos membros da equipe a fim de fazer uma aula prática sobre git e trabalho em equipe.

Tarefas

  • Apresentar principais funcionalidades do git;
  • Apresentar uso de ferramentas voltadas para trabalho em equipe.

Critérios de aceitação

  • Apresentar recursos do git que serão utilizados durante o semestre (co-authored, git flow, pull requests etc);
  • Apresentar tecnologias que facilitem o trabalho em equipe (vscode, live share etc.)

Documentar sprint 0

Descrição

Documentar na wiki a revisão e a retrospectiva da sprint 0 com todos os levantamentos e avaliações realizados, além de documentar as tarefas desenvolvidas durante o período da sprint.

Tarefas

  • Adicionar considerações do Scrum Master;
  • Adicionar métricas;
  • Elencar pontos de melhoria.

Critérios de Aceitação ?

  • Documentar na wiki.

Criar primeira versão do documento de identidade visual

Descrição

Com base na reunião realizada com a PO, desenvolver a primeira versão do documento de identidade visual, observadas as anotações realizadas no documento de questionário realizado com a professora.

Tarefas

  • Criar primeira versão do documento de identidade visual.

Critérios de Aceitação

  • Validar com a professora Altaci (PO);
  • Observar anotações do documento de questionário (relativo a cores, logo).

Criar documento de planejamento da sprint 3

Descrição

Issue destinada a documentar o planejamento da sprint 2 na wiki

Tarefas

  • Documentar atividades desenvolvidas;
  • Documentar papéis desempenhos por membros da equipe;
  • Documentar pareamentos.

Critérios de Aceitação

  • Documentar na wiki

Configurar wiki com MKDocs Material

Descrição

Com o objetivo de tornar mais transparente e organizado o desenvolvimento do projeto, a presente issue destina-se a disponibilização da wiki do projeto com MKDocs Material.

Tarefas

  • Criar wiki com MKDocs Material;
  • Configurar docker para a wiki;
  • Adicionar extensões do MKDocs Material;
  • Realizar deploy com GitHub Pages;
  • [ ] Se necessário, escrever scripts bash que automatizem tarefas.

Observações

Estudar react native

Descrição

Realizar dojo de react native com a equipe de forma a apresentar os principais conceitos da tecnologia.

Tarefas

  • Conceitos gerais sobre aplicação react;
  • Hierarquia (organização) em uma aplicação react native;
  • Componentização;
  • Typescript + React;
  • JSX;
  • Context API;
  • Uso dos principais hooks (useState, useEffect);
  • Uso de props, prop drilling;
  • Estilização em react;
  • Outros.

Critérios de Aceitação

  • Realizar treinamento com a equipe.

Documentações

Desenvolver protótipo de baixa fidelidade

Descrição

Com base na reunião realizada com a PO, desenvolver protótipo de baixa fidelidade para levantar ideias e aspectos visuais de interação que o usuário virá a ter na aplicação.

Tarefas

  • Discutir e desenvolver união do protótipo de baixa fidelidade.

Protótipos

  • Luís e Lucas;
  • Laís e Vargas;
  • André;
  • Lieverton.

Critérios de Aceitação

  • Protótipo em papel ou digital;
  • Foco na interação, não no visual;
  • Comentar com imagem ou link do protótipo nessa issue.

Observações

Caso opte por utilizar uma ferramenta digital, segue sugestões:

Adicionar configurações de lint locais

Descrição

Como o projeto será desenvolvido em python e javascript é de extrema importância que os códigos desenvolvidos sigam padrões e diretrizes das comunidades dessas linguagens. Desse modo, será possível alinhar e melhorar a qualidade de código do projeto.

Tarefas

Backend

  • Configurar adequadamente pylint nos ambientes de backend.

Frontend

  • Configurar adequadamente eslint no ambiente do frontend.

Critérios de Aceitação

  • Husky deve bloquear commits que não sigam a folha de estilo;
  • Membros da equipe devem saber utilizar o lint, especialmente no vscode.

Documentar roadmap de papéis

Descrição

Issue destinada a documentar o roadmap de papéis e atividades que serão desenvolvidas durante a elaboração do projeto.

Tarefas

  • Documentar roadmap do scrum master;
  • Documentar roadmap do devops;
  • Documentar roadmap do product owner / product manager;
  • Documentar roadmap do arquiteto;
  • Documentar roadmap do analista de dados.

Critérios de Aceitação

  • Documentação de todos os papéis;
  • Documentar na wiki.

Observação

  • Seguir estrutura de um EAP ou similar (dividir por papéis).

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.