Merge pull request #81 from fga-eps-mds/release/v0.1.0

Release/v0.1.0
fga-eps-mds · Oct 8, 2019 · 3d34905 · 3d34905
2 parents 6adf993 + 51266c9
commit 3d34905
Show file tree

Hide file tree

Showing 128 changed files with 7,560 additions and 603 deletions.
diff --git a/.env.development b/.env.development
@@ -0,0 +1 @@
+VUE_APP_API_URL=http://localhost:8000/api/v1
diff --git a/.gitignore b/.gitignore
@@ -22,3 +22,6 @@ yarn-error.log*
 *.njsproj
 *.sln
 *.sw?
+
+# Local Netlify folder
+.netlify
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
@@ -7,8 +7,7 @@ cache:
 stages:
   - test
   - build
-  - lint
-  - release
+  - deploy
 
 # Stage I
 # Testing Phase:
@@ -17,6 +16,7 @@ stages:
 test:
   stage: test
   script:
+   - rm -rf package-lock.json
    - npm install
    - npm run test:unit
    - npm run lint
@@ -25,17 +25,47 @@ test:
 
 # Stage II
 # Build Phase:
-# This is where the main code is tested.
+# This is where the main code is built.
 build:
   stage: build
   script:
+    - rm -rf package-lock.json
     - npm install @vue/cli
     - npm install
     - npm run build
   artifacts:
     paths:
       #build folder
       - dist/
+
+
+# Stage III
+# Release Phase
+# At this stage our application is deployed
+.release:
+  stage: deploy
+  script:
+    - rm -rf package-lock.json
+
+    - npm install
+    - npm i -g netlify-cli
+    - netlify deploy --site $NETLIFY_SITE_ID --auth $NETLIFY_AUTH_TOKEN --prod
+  dependencies:
+    - build
 
+release_production:
+  extends: .release
+  environment: production
+  only:
+    - tags
+  except:
+   - ^(?!master).+@/
 
+release_development:
+  extends: .release
+  environment: 
+    name: development
+    url: https://arbc-lab.netlify.com
+  only: 
+    - master
 
diff --git a/AR_markers/base_images/A.png b/AR_markers/base_images/A.png
diff --git a/AR_markers/base_images/Acirc.png b/AR_markers/base_images/Acirc.png
diff --git a/AR_markers/base_images/B.png b/AR_markers/base_images/B.png
diff --git a/AR_markers/base_images/C.png b/AR_markers/base_images/C.png
diff --git a/AR_markers/base_images/D.png b/AR_markers/base_images/D.png
diff --git a/AR_markers/base_images/E.png b/AR_markers/base_images/E.png
diff --git a/AR_markers/base_images/Ecirc.png b/AR_markers/base_images/Ecirc.png
diff --git a/AR_markers/base_images/F.png b/AR_markers/base_images/F.png
diff --git a/AR_markers/base_images/G.png b/AR_markers/base_images/G.png
diff --git a/AR_markers/base_images/H.png b/AR_markers/base_images/H.png
diff --git a/AR_markers/base_images/I.png b/AR_markers/base_images/I.png
diff --git a/AR_markers/base_images/J.png b/AR_markers/base_images/J.png
diff --git a/AR_markers/base_images/K.png b/AR_markers/base_images/K.png
diff --git a/AR_markers/base_images/L.png b/AR_markers/base_images/L.png
diff --git a/AR_markers/base_images/M.png b/AR_markers/base_images/M.png
diff --git a/AR_markers/base_images/N.png b/AR_markers/base_images/N.png
diff --git a/AR_markers/base_images/O.png b/AR_markers/base_images/O.png
diff --git a/AR_markers/base_images/Ocirc.png b/AR_markers/base_images/Ocirc.png
diff --git a/AR_markers/base_images/P.png b/AR_markers/base_images/P.png
diff --git a/AR_markers/base_images/Pattern.psd b/AR_markers/base_images/Pattern.psd
diff --git a/AR_markers/base_images/Q.png b/AR_markers/base_images/Q.png
diff --git a/AR_markers/base_images/R.png b/AR_markers/base_images/R.png
diff --git a/AR_markers/base_images/S.png b/AR_markers/base_images/S.png
diff --git a/AR_markers/base_images/T.png b/AR_markers/base_images/T.png
diff --git a/AR_markers/base_images/U.png b/AR_markers/base_images/U.png
diff --git a/AR_markers/base_images/V.png b/AR_markers/base_images/V.png
diff --git a/AR_markers/base_images/W.png b/AR_markers/base_images/W.png
diff --git a/AR_markers/base_images/X.png b/AR_markers/base_images/X.png
diff --git a/AR_markers/base_images/Y.png b/AR_markers/base_images/Y.png
diff --git a/AR_markers/base_images/Z.png b/AR_markers/base_images/Z.png
diff --git a/AR_markers/base_images/Á.png b/AR_markers/base_images/Á.png
diff --git a/AR_markers/base_images/Ã.png b/AR_markers/base_images/Ã.png
diff --git a/AR_markers/base_images/Ç.png b/AR_markers/base_images/Ç.png
diff --git a/AR_markers/base_images/É.png b/AR_markers/base_images/É.png
diff --git a/AR_markers/base_images/Í.png b/AR_markers/base_images/Í.png
diff --git a/AR_markers/base_images/Ó.png b/AR_markers/base_images/Ó.png
diff --git a/AR_markers/base_images/Õ.png b/AR_markers/base_images/Õ.png
diff --git a/AR_markers/base_images/Ú.png b/AR_markers/base_images/Ú.png
diff --git a/Dockerfile b/Dockerfile
@@ -1,7 +1,5 @@
 FROM node:carbon-alpine
 
-LABEL name="ArBC"
-
 ENV ArBC_FRONTEND=noninteractive
 
 WORKDIR /usr/app

diff --git a/README.md b/README.md
@@ -1,39 +1,63 @@
-# 2019.2-arbc
+[![Codacy Badge](https://api.codacy.com/project/badge/Grade/9597bd729fa34472aa1a10de74557942)](https://www.codacy.com/manual/lucianosz7/2019.2-ArBC?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=fga-eps-mds/2019.2-ArBC&amp;utm_campaign=Badge_Grade)
 
-## Project setup
+![](https://jlucassr.github.io/ArBC-Pages/imagens/logo.jpg)
+
+## Sobre
+ O ArBC é uma aplicação web baseada nas APIs de RA (Realidade Aumentada) [AR.js](https://github.com/jeromeetienne/AR.js/) e [A-Frame](https://aframe.io/), que tem como objetivo tornar o processo de alfabetização mais interativo e engajante por meio desta tecnologia.
+ A aplicação possui um front-end baseado no Vue.js (com a biblioteca [Vuex](https://vuex.vuejs.org/)) e [back-end](https://github.com/fga-eps-mds/2019.2-ArBC-API/) baseado em Django.
+
+## Principais funcionalidades
+
+-  Reconhecimento de letras através de patterns de RA.
+-  Reconhecimento de palavras utilizando estas mesmas letras.
+-  Visualização de imagens em cima da pattern ou palavra       reconhecida em tempo real.
+
+## Clonar repositório 
+
+```
+git clone https://github.com/fga-eps-mds/2019.2-ArBC/
+```
+
+## Rodar ambiente docker
+
+sudo docker-compose build
+sudo docker-compose up
+``` 
+
+## Como instalar
 ```
 npm install
 ```
 
-### Compiles and hot-reloads for development
+### Compilar e roda para desenvolvimento
 ```
 npm run serve
 ```
 
-### Compiles and minifies for production
+### Compilar e roda build
 ```
 npm run build
 ```
 
-### Run your tests
+### Rodar testes
 ```
 npm run test
 ```
 
-### Lints and fixes files
+### Lint e consertar arquivos
 ```
 npm run lint
 ```
 
-### Run your end-to-end tests
+### Rodar testes end-2-end
 ```
 npm run test:e2e
 ```
 
-### Run your unit tests
+### Rodar testes unitários
 ```
 npm run test:unit
 ```
 
-### Customize configuration
-See [Configuration Reference](https://cli.vuejs.org/config/).
+## Licença
+ArBC é distribuído sob a licença GPL v3.0. Consulte nosso arquivo [LICENSE](https://github.com/fga-eps-mds/2019.2-ArBC/blob/da5b0706c50af1bbc65694b5e0bf8d5d97d0e03b/LICENSE) para saber mais.
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -2,7 +2,7 @@ version: '3'
 
 services:
   arbc_app:
-    container_name: ArBCDockerize
+    container_name: ArBC-APP
     build: .
     #command: npm install
     ports:

diff --git a/docs/Plano-Comunicacao.md b/docs/Plano-Comunicacao.md
@@ -0,0 +1,70 @@
+# Histórico de Versões
+
+Data|Versão|Descrição|Autor
+-|-|-|-
+30/09|1.0.0|Criação do Documento| João Lucas|
+
+## 1. <a name="1_1">Objetivo</a>
+
+ <p align = "justify"> &emsp;&emsp; Este documento tem como objetivo evidenciar a comunicação interna da equipe e as ferramentas utilizadas para obtenção da mesma. As ferramentas utilizadas tem principal função de facilitar a comunicação e que torne eficiente as soluções das dúvidas referentes ao andamento do projeto.
+
+
+## 2. <a name="1_1">Ferramentas</a>
+
+#### Telegram
+
+<p align = "justify"> &emsp;&emsp; O Telegram é um serviço de mensagens instantâneas baseado na nuvem. O Telegram está disponível para smartphones ou tablets, computadores e também como Aplicação web. Os usuários podem enviar mensagens e trocar fotos, vídeos, stickers e arquivos de qualquer tipo.
+<p align = "justify"> &emsp;&emsp; Para uso do projeto, o aplicativo servirá para comunicações entre os membros da equipe, como reuniões, dúvidas, horários, entregas, discussões e etc. </p>
+
+
+<p align = "center"> &emsp;&emsp; <img src="https://fga-eps-mds.github.io/2019.1-Aix/assets/img/telegram-logo.png" width="200" height="200"/> </p>
+
+#### GitHub
+
+<p align = "justify"> &emsp;&emsp; GitHub é uma plataforma de hospedagem de código-fonte com controle de versão usando o Git. Ele permite que programadores, utilitários ou qualquer usuário cadastrado na plataforma contribuam em projetos privados e/ou Open Source de qualquer lugar do mundo.
+
+<p align = "justify"> &emsp;&emsp; O GitHub é essencial na transparência interna da equipe e externa junto ao clientes, e os professores orientadores do projeto Carla Rocha e Joênio e a comunidade em geral. Serve também para comunicação entre os membros da equipe, para dúvidas sobre a issue e para mostrar o andamento do projeto.
+
+<p align = "center"> &emsp;&emsp; <img src="https://image.flaticon.com/icons/svg/25/25231.svg" width="200" height="200"/> </p>  
+
+#### ZenHub
+
+<p align = "justify"> &emsp;&emsp; O ZenHub é um gerenciamento ágil de projetos no GitHub. Adicione recursos avançados de rastreamento, planejamento e relatórios ao GitHub.
+
+<p align = "justify"> &emsp;&emsp; Por esta ferramenta, aplica-se o Kanban e monitora-se o andamento das issues.
+
+<p align = "center"> &emsp;&emsp; <img src="https://cdn.slant.co/c8016551-95d3-447c-9ab4-30dcaf6e51d2/-/format/jpeg/-/progressive/yes/-/preview/480x480/" width="200" height="200"/> </p>  
+
+#### Slack
+
+<p align = "justify"> &emsp;&emsp; O Slack é um conjunto de ferramentas de software de colaboração em equipe e serviços online baseados na nuvem, desenvolvido pela Slack Technologies.
+
+<p align = "justify"> &emsp;&emsp; Pela ferramenta os membros do grupo defini horários das reuniões, realizam Dailies, monitora os commits no git entre outros.
+
+<p align = "center"> &emsp;&emsp; <img src="https://user-images.githubusercontent.com/819186/51553744-4130b580-1e7c-11e9-889e-486937b69475.png" width="200" height="200"/> </p>  
+
+#### Hangouts
+
+<p align = "justify"> &emsp;&emsp; Google Hangouts é uma plataforma de comunicação, desenvolvida pela Google, que inclui mensagens instantâneas, chat de vídeo, SMS e VOIP.
+
+<p align = "justify"> &emsp;&emsp; Utilizamos para dailies e reuniões não presenciais, também para soluções de dúvidas e treinamentos não presenciais.
+
+<p align = "center"> &emsp;&emsp; <img src="https://fga-eps-mds.github.io/2019.1-Aix/assets/img/hangouts.png" width="200" height="200"/> </p>  
+
+#### Google Drive
+
+<p align = "justify"> &emsp;&emsp; Google Drive é um serviço de armazenamento e sincronização de arquivos que abriga o Google Docs, um leque de aplicações de produtividade, que oferece a edição de documentos, folhas de cálculo, apresentações, e muito mais
+
+<p align = "justify"> &emsp;&emsp; Utilizado como ferramenta de comunicação estática e criação de slides e planilhas do projeto, onde os artefatos são mantidos.
+
+<p align = "center"> &emsp;&emsp; <img src="https://upload.wikimedia.org/wikipedia/commons/thumb/d/da/Google_Drive_logo.png/250px-Google_Drive_logo.png" width="200" height="200"/> </p>
+
+## 3. <a name="1_1">Estratégias de Comunicação</a>
+
+### 3.1. <a name="1_1">Comunicação Interna</a>
+
+<p align = "justify"> &emsp;&emsp; A comunicação interna entre os times de EPS e MDS, ocorrerá ferramentas descritas na tabela acima. Os times terão reuniões semanalmente, podendo ser presenciais ou remotas. Essas reuniões são fixas e ocorrerão todo sábado, com horário de início definido às 14:00 e horário de término previsto até às 18:00. Caso tenha necessidade de uma reunião para a discussão ou resolução de problemas urgentes, a reunião poderá acontecer qualquer dia da semana de forma que maior quantidade de membros possam estar presentes.
+
+### 3.1. <a name="1_1">Comunicação Externa</a>
+
+<p align = "justify"> &emsp;&emsp; No caso do projeto, não há um cliente real. Porém esclarecimentos são realizados por meio da comunicação com os professores Carla e Joênio no apoio ao desenvolvimento do projeto pela ferramenta telegram ou por reuniões semanais que acontecem geralmente ao término das aulas das disciplinas. Outras comunicações ocorrem com o Pablo Diego e com Rodrigo Oliveira para demais dúvidas e introdução do projeto.
diff --git a/docs/Plano-Gerenciamento-Riscos.md b/docs/Plano-Gerenciamento-Riscos.md
@@ -0,0 +1,87 @@
+## Histórico de Revisão
+
+|    Data    | Versão |                             Alteração                             |                    Autor                    |
+|:----------:|:------:|:-----------------------------------------------------------------:|:-------------------------------------------:|
+|30/09| 1.0.0| Criação do Documento |João Lucas|
+
+## 1. Introdução
+<p align="justify"> &emsp;&emsp; O Plano de Gerenciamento de Riscos tem por objetivo a identificação, análise e planejamento de medidas para os possíveis riscos que o projeto pode enfrentar. Depois do planejamento, torna-se possível fazer a gerência dos riscos, esta será feita pelo scrum master ao decorrer das sprints.
+
+## 2. Estrutura Analítica de Riscos (EAR)
+
+<p align="justify"> &emsp;&emsp; Esta estrutura é responsável por agrupar as possíveis causas dos riscos, o que facilita os reconhecimentos e tratamentos  de riscos do projeto, facilitando o processo de mitigação dos riscos. Tem como objetivo mostrar as principais categorias de risco para um tipo de projeto buscando especificidade, pois dessa forma o ganho de tempo na identificação é mais significativo. Os riscos podem ser classificados de acordo com as categorias: </p>
+
+* **Técnico**: São riscos associados à tecnologia, requisitos e qualidade.
+* **Externo**: São os riscos relativos ao cliente, mercado ou ambiente.
+* **Organizacional**: São relacionados à priorização e recursos do projeto.
+* **Gerência**: São relativos à estimativa, planejamento, controle e comunicação.
+
+## 3.Análise Quantitativa
+
+### 3.1. Probabilidade
+
+|Probabilidade|Intervalo|Peso|
+|:----:|:-----:|:------:|
+|**Muito Baixa**|0 a 10|1|
+|**Baixa**| 11 a 30|2|
+|**Média**| 31 a 50|3|
+|**Alta**| 51 a 65|4|
+|**Muito Alta**| 65 a 100| 5|
+
+### 3.2. Impacto
+
+|Impacto|Descrição|Peso|
+|:----:|:-----:|:------:|
+|**Muito Baixo**|Impacto pouco expressivo no desenvolvimento do projeto|1|
+|**Baixo**| Pouco impacto no desenvolvimento do projeto|2|
+|**Médio**| Possui certo impacto porém é facilmente recuperado|3|
+|**Alto**| Há grande impacto no desenvolvimento do projeto|4|
+|**Muito Alto**| O impacto inviabiliza o projeto| 5|
+
+### 3.3. Prioridade
+
+<p align="justify"> &emsp;&emsp; Se baseando com os valores do impacto e de probabilidade calcula-se a prioridade dos riscos. O que determina a urgência com que medidas devem ser tomadas para mitigar ou resolver um risco que pode impedir o projeto.
+
+|Probabilidade/Impacto|Muito Baixa|Baixo|Média|Alta|Muito Alta|
+|:----:|:-----:|:------:|:------:|:------:|:------:|
+|**Muito Baixa**|1|2|	3|	4|	5|
+|**Baixa**| 2|4	|6	|8	|10|
+|**Média**| 3|6|	9	|12|	15|
+|**Alta**| 4| 8	|12	|16|	20|
+|**Muito Alta**| 5| 	10|	15	|20	|25|
+
+#### 3.3.1. Valor de Prioridade
+
+|Prioridade|Intervalo|
+|:----:|:-----:|
+|Muito Baixo|1 a 5|
+|Baixo| 6 a 10|
+|Médio| 11  a 15|
+|Alto| 16 a 20|
+|Muito Alto| 21 a 25 |
+
+## 4. Identificação dos Riscos
+<p align="justify"> &emsp;&emsp; O processo de identificação de riscos se utilizou de identificação de riscos através da comparação análoga - método que se utiliza de experiências anteriores e similares para facilitar a concepção e identificação comum em projetos do gênero.
+
+## Riscos levantados
+
+|Risco| Descrição|	Ação Preventiva|	Ação Reativa|Categoria	|Probabilidade	|Impacto|	Prioridade|
+|:----:|:-----:|:-----:|:-----:|:-----:|:-----:|:-----:|:-----:|
+|**R01**|Dificuldades da equipe com as novas tecnologias inseridas	|Seleção de alunos experientes para aplicação de treinamento.	|Realização de treinamento sobre tecnologias.	|Técnico|	4|	5|	20|
+|**R02**|Divergência de horários entre membros da equipe|	Elaboração de quadro de horários disponíveis da cada membro da equipe.|	Planejamento de de pareamento por sprint baseado na disponibilidade dos integrantes por meio do quadro de disponibilidade.|	Gerência|	4|	3|	12|
+|**R03**|Desistência da disciplina.|	Estimular a máxima participação dos membros da equipe|	Redistribuir tarefas de forma que não ocorra sobrecarga para nenhum dos membros do grupo e que o grupo consiga interagir da melhor maneira possível.	|Gerência	|2	|5|	10|
+|**R04**|Alteração do escopo|	Documentar e refinar de forma constante os requisitos|	Planejar corretamente a sprint e se manter atualizado quanto às novas funcionalidades que serão adicionadas ao projeto|	Gerência|	5	|4	|20|
+|**R05**|Alteração das tecnologias	|Definir de forma concisa o escopo do projeto	|Planejar corretamente a sprint e se manter atualizado quanto às novas funcionalidades que serão adicionadas ao projeto	|Técnico	|4	|5	|20|
+|**R06**|Presença dos membros durante Daily e Reuniões de planejamento	|Definir datas, horários e locais que sejam acessíveis a todos.|	Manter o time sempre alinhado quanto às decisões tomadas.|	Gerência|	4|	3	|12|
+|**R07**|Falta de cliente real|	Utilização de ferramentas que ajudem a levantar requisitos|	Utilização de dados levantados por usuários que sejam o público alvo do projeto.|	Externo	|5|	2	|10|
+|**R08**|Dependência entre as atividades	|Priorização das atividades	|Planejar Sprints de forma a evitar o excesso de dependências entras as issues|	Organizacional	|3|	3|	9|
+|**R09**|Baixa produtividade dos integrantes do grupo	|Motivação da equipe quanto a criação do projeto através de reuniões constantes|	Aplicação de atividades de Gamificação e lúdicas do projeto para reintegração de membros desmotivados	|Gerência|	3|	5|	15|
+|**R10**|Dificuldade de comunicação entre os membros do grupo	|Elaborar e seguir plano de comunicações|	Reuniões presenciais com a equipe para tomada de decisões	|Gerência	|3|	4|	12|
+
+## 6. Bibliografia
+
+* RODRIGUES, Eli. EAR para projetos de software. Disponível em https://www.elirodrigues.com/2013/09/21/gerenciamento-de-riscos-ear-para-projetos-de-software/. Acesso em 30 set 2019.
+
+* SIQUEIRA, Lucas; OLIVEIRA, Caio. Plano de Gerenciamento de Riscos do grupo +Monitoria. Disponível em: <https://fga-eps-mds.github.io/2019.1-MaisMonitoria/docs/plano-riscos>. Acesso em 30 set 2019.
+
+* VITOR, Lucas. Plano de Gerenciamento de Riscos do grupo Aix. Disponível em: <https://fga-eps-mds.github.io/2019.1-Aix/gerencia/2019/04/06/plano-de-gerenciamento-de-riscos/>. Acesso em 30 set 2019.
diff --git a/docs/Product-Backlog.md b/docs/Product-Backlog.md
@@ -0,0 +1,47 @@
+## Histórico de Revisão
+
+|    Data    | Versão |                             Alteração                             |                    Autor                    |
+|:----------:|:------:|:-----------------------------------------------------------------:|:-------------------------------------------:|
+|31/08| 1.0.0| Criação do Documento no Drive |João Lucas|
+|02/09| 1.1.0| Adição de novas Features| Eduardo Lima |
+|07/09| 1.2.0| Adição das Histórias de Usuários | João Lucas, Eduardo Lima e Luciano Santos |
+|30/09 | 1.2.1 | Atualização do Backlog | João Lucas |
+
+### Tema
+
+|    ID   | Descrição |
+|:-----------------------------------------------------------------:|:-------------------------------------------:|
+|TM01	|ArBC|
+
+
+### Épicos
+
+|    ID   | Descrição |
+|:-----------------------------------------------------------------:|:-------------------------------------------:|
+|EP01|Como Educador, eu desejo que a aplicação permita a visualização de uma imagem por meio da câmera do celular|
+
+### Features
+
+|    ID   | Descrição |
+|:-----------------------------------------------------------------:|:-------------------------------------------:|
+|FT01|	Gerenciamento de imagens|
+|FT02|	Identificar palavras|
+|FT03|	Identificar letras|
+|FT04|	Gerenciamento de interface gráfica|
+|FT05|	Procurar Gifs|
+|FT06|	Banco de Dados|
+|FT07|	Câmera do celular|
+|FT08|	Validar da palavra|
+|FT09|	Montar as palavras através das letras|
+|FT10	|Mostrar a imagem|
+
+### User Stories
+
+|ID	|Eu, como|	Desejo|	Épicos|	Features|	Pontuação|
+|:-----:|:---------:|:--------:|:----------:|:---------------------------------:|:-------------------------------------------:|
+|US01	|Educador|	ler a letra	|EP01	|FT01, FT02, FT03, FT04, FT05, FT06, FT07, FT08, FT09, FT10	|8|
+|US02	|Educador|	ler a palavra através de um conjunto de letras	|EP01|	FT01, FT02, FT03, FT04, FT05, FT06, FT07, FT08, FT09, FT10	|21|
+|US03	|Educador|	identificar se a palavra escrita tenha uma imagem correspondente| 	EP01	|FT01, FT02, FT03, FT04, FT05, FT06, FT07, FT08, FT09, FT10	|8|
+|US04|	Educador|	visualizar uma imagem através de uma palavra|	EP01|	FT01, FT02, FT03, FT04, FT05, FT06, FT07, FT08, FT09, FT10|	13|
+
+O link da planilha do Product Backlog se encontra nesse [link](https://docs.google.com/spreadsheets/d/1wnT7UdFTu3rCG1Sdsv5C9kS0KtDUBNw9O5ffhebFGvI/edit?usp=sharing).