| ... | ... | @@ -7,42 +7,54 @@ |
|
|
|
</tr>
|
|
|
|
</table>
|
|
|
|
|
|
|
|
# Stakeholders
|
|
|
|
# **STAKEHOLDERS**
|
|
|
|
|
|
|
|
- Poder Judiciário do Estado do Rio Grande do Sul
|
|
|
|
- Ministério Público do Estado do Rio Grande do Sul
|
|
|
|
|
|
|
|
## Reuniões
|
|
|
|
|
|
|
|
[12/05/2017 - Apresentação do Projeto](http://www.tools.ages.pucrs.br/AGES-Adocoes/Adocoes/wikis/resolucoes-reuniao-stakeholder-12-05-17)
|
|
|
|
- [12/05/2017 - Apresentação do Projeto](http://www.tools.ages.pucrs.br/AGES-Adocoes/Adocoes/wikis/resolucoes-reuniao-stakeholder-12-05-17)
|
|
|
|
|
|
|
|
[09/06/2017 - Ajuste de Requisitos](http://www.tools.ages.pucrs.br/AGES-Adocoes/Adocoes/wikis/resolucoes-reuniao-stakeholder-09-06-17)
|
|
|
|
- [09/06/2017 - Ajuste de Requisitos](http://www.tools.ages.pucrs.br/AGES-Adocoes/Adocoes/wikis/resolucoes-reuniao-stakeholder-09-06-17)
|
|
|
|
|
|
|
|
# **ACOMPANHE O PROJETO**
|
|
|
|
# **TIME DE PROJETO**
|
|
|
|
|
|
|
|
[Kanban](http://www.kanban.ages.pucrs.br/boards/projetos/Adocoes)
|
|
|
|
|
|
|
|
[Repositório Git da API REST](http://www.tools.ages.pucrs.br/AGES-Adocoes/Adocoes)
|
|
|
|
|
|
|
|
[Repositório Git do Aplicativo Android](http://www.tools.ages.pucrs.br/AGES-Adocoes/adocoes-android)
|
|
|
|
|
|
|
|
## Estrutura dos times
|
|
|
|
## Times 2017-2
|
|
|
|
|
|
|
|
### Arquitetura de Software + DevOps
|
|
|
|
|
|
|
|
Eduardo + Vaccaro
|
|
|
|
|
|
|
|
### Rest API
|
|
|
|
|
|
|
|
Matheus + Thiago + Gabriel + Gregory + Gabriel + Ramiro + Guilherme
|
|
|
|
|
|
|
|
### Android
|
|
|
|
### Aplicativo Android
|
|
|
|
|
|
|
|
Homero + Vaccaro + Israel + Hercilio + Eduardo + João + Juan
|
|
|
|
|
|
|
|
### HTML
|
|
|
|
### Aplicativo HTML Responsivo
|
|
|
|
|
|
|
|
A ser definido após a completação da Rest API
|
|
|
|
|
|
|
|
## Reuniões
|
|
|
|
|
|
|
|
- Reunião Inicial (Aula de 11/08/17)
|
|
|
|
- 
|
|
|
|
- 
|
|
|
|
|
|
|
|
# **ACOMPANHAMENTO DO PROJETO**
|
|
|
|
|
|
|
|
[Kanban](http://www.kanban.ages.pucrs.br/boards/projetos/Adocoes)
|
|
|
|
|
|
|
|
[Repositório Git da API REST](http://www.tools.ages.pucrs.br/AGES-Adocoes/Adocoes)
|
|
|
|
|
|
|
|
[Repositório Git do Aplicativo Android](http://www.tools.ages.pucrs.br/AGES-Adocoes/adocoes-android)
|
|
|
|
|
|
|
|
# **ENGENHARIA DE REQUISITOS**
|
|
|
|
|
|
|
|
# 1 Requisitos funcionais
|
|
|
|
## Requisitos funcionais
|
|
|
|
|
|
|
|
Além do atendimento dos requisitos acadêmicos, o **Projeto Adoções** tem por objetivo o desenvolvimento de uma solução de incentivo à adoção de menores.
|
|
|
|
|
| ... | ... | @@ -54,25 +66,31 @@ Ao final deste desenvolvimento, todos os artefatos produzidos serão disponibili |
|
|
|
|
|
|
|
O projeto será desenvolvido em dois semestres 2017/1 e 2017/2, sendo entregue no final do mês de dezembro de 2017.
|
|
|
|
|
|
|
|
## 1.1 [Aplicativo para Dispositivos Móveis](./requisitos aplicativo)
|
|
|
|
## [Aplicativo Android](./requisitos aplicativo)
|
|
|
|
|
|
|
|
[Aqui](./requisitos aplicativo) você conhece os requisitos do aplicativo para dispositivos móveis.
|
|
|
|
|
|
|
|
## 1.2 [Ferramenta de Gestão via Web](./requisitos web)
|
|
|
|
## [API REST](./requisitos api)
|
|
|
|
|
|
|
|
[Aqui](./requisitos api) você conhece os requisitos da API REST.
|
|
|
|
|
|
|
|
## Aplicativo HTML Responsivo
|
|
|
|
|
|
|
|
A ser especificado.
|
|
|
|
|
|
|
|
## ~~[Ferramenta de Gestão via Web](./requisitos web)~~ - DEPRECATED
|
|
|
|
|
|
|
|
[Aqui](./requisitos web) você conhece os requisitos do aplicativo para dispositivos móveis da ferramenta web de gestão.
|
|
|
|
|
|
|
|
**No curso do projeto, a equipe do Departamento de Informática do Tribunal de Justiça assumiu o desenvolvimento da ferramenta de gestão.**
|
|
|
|
|
|
|
|
## 1.3 [API REST](./requisitos api)
|
|
|
|
# **PROJETO DE USABILIDADE (UX - User eXperience**)
|
|
|
|
|
|
|
|
[Aqui](./requisitos api) você conhece os requisitos da API REST.
|
|
|
|
|
|
|
|
# 2 Mockups de Telas
|
|
|
|
Veja os mockups (rascunhos) e layouts de telas que embasarão o desenvolvimento do aplicativo e da ferramenta web de gestão.
|
|
|
|
|
|
|
|
Veja os mockups (rascunhos) de telas que embasarão o desenvolvimento do aplicativo e da ferramenta web de gestão.
|
|
|
|
## [Aplicativo Android](./mockups-aplicativo)
|
|
|
|
|
|
|
|
## [Aplicativo](./mockups-aplicativo)
|
|
|
|
### Mockups
|
|
|
|
|
|
|
|
<p align="center">
|
|
|
|
<img src="/uploads/219335cfe31b5d288806ad880232e6bd/1-login.png?raw=true" alt="0001" height=70px" style="border-width: 1px; border-color: Black;"/>
|
| ... | ... | @@ -97,7 +115,17 @@ Veja os mockups (rascunhos) de telas que embasarão o desenvolvimento do aplicat |
|
|
|
<img src="/uploads/9a9d0832ae7a076257b9465cfd791130/20-Sobre.png?raw=true" alt="0001" height=70px" style="border-width: 1px; border-color: Black;"/>
|
|
|
|
</p>
|
|
|
|
|
|
|
|
## [Site Web](./mockups-web)
|
|
|
|
### [Layouts de Telas (BEPiB](./layouts)
|
|
|
|
|
|
|
|
Veja os [layouts das telas](./layouts) do aplicativo para dispositivos móveis que já foram elaborados pelo BEPiD. Os layouts das telas serão elaborados com apoio de outras equipes. Aguardem novidades!
|
|
|
|
|
|
|
|
### Layouts de Telas (TJ-RS)
|
|
|
|
|
|
|
|
Aguardem novidades!!!
|
|
|
|
|
|
|
|
## [Aplicativo HTML Resposivo](./mockups-web)
|
|
|
|
|
|
|
|
### Mockups
|
|
|
|
|
|
|
|
<p align="center">
|
|
|
|
<img src="/uploads/9e3770bd6e43a00190285f5132f77675/0001.jpg"?raw=true" alt="0001" height=70px" style="border-width: 1px; border-color: Black;"/>
|
| ... | ... | @@ -112,7 +140,11 @@ Veja os mockups (rascunhos) de telas que embasarão o desenvolvimento do aplicat |
|
|
|
<img src="/uploads/6841627746b4d527d07b71d71c151096/0010.jpg"?raw=true" alt="0010" height=70px" style="border-width: 1px; border-color: Black;"/>
|
|
|
|
</p>
|
|
|
|
|
|
|
|
## [Ferramenta de Gestão](./mockups-web-adm)
|
|
|
|
### Layouts de Telas (TJ-RS)
|
|
|
|
|
|
|
|
Aguardem novidades!!!
|
|
|
|
|
|
|
|
## ~~[Ferramenta de Gestão Web](./mockups-web-adm)~~ - DEPRECATED
|
|
|
|
|
|
|
|
<p align="center">
|
|
|
|
<img src="/uploads/3a38abcb748725a16ff40587dc6ba566/001.jpg"?raw=true" alt="001" height=70px" style="border-width: 1px; border-color: Black;"/>
|
| ... | ... | @@ -128,141 +160,175 @@ Veja os mockups (rascunhos) de telas que embasarão o desenvolvimento do aplicat |
|
|
|
|
|
|
|
# **ANÁLISE**
|
|
|
|
|
|
|
|
# 1 [Modelagem de Dados](./modelagem)
|
|
|
|
## [Modelagem de Dados](./modelagem)
|
|
|
|
|
|
|
|
O Projeto Adoções adotará o sistema de gerência de bancos de dados não-relacional MongoDB. Para tanto, foi realizada a [modelagem conceitual e lógica dos dados](./modelagem).
|
|
|
|
|
|
|
|
# **PROJETO**
|
|
|
|
# **IMPLEMENTAÇÃO E TESTES UNITÁRIOS**
|
|
|
|
|
|
|
|
# 1 [API REST](./requisitos api)
|
|
|
|
## API REST
|
|
|
|
|
|
|
|
[Aqui](./requisitos api) você confere os requisitos funcionais e não funcionais da API REST que será consumida pelo aplicativo para dispositivos móveis.
|
|
|
|
### Ambiente de Desenvolvimento
|
|
|
|
|
|
|
|
# 2 [Layouts de Telas](./layouts)
|
|
|
|
- Para configurar o ambiente de desenvolvimento local é necessário instalar:
|
|
|
|
- [Node.js](https://nodejs.org/en/)
|
|
|
|
- [Mongo DB](./Mongo-DB)
|
|
|
|
- RoboMongo ou outro cliente para o MongoDB
|
|
|
|
- Após instalar o MongoDB, abrir o [script para popular MongoDB](http://www.tools.ages.pucrs.br/AGES-Adocoes/Adocoes/blob/d8e88d26c9dc9ea9d83b82c3e23da3222844e632/api/test/inicializacaoMongo.mongo) e inserir no DB os seguintes objetos iniciais:
|
|
|
|
- "testCliente": inserir na collection "clientes": cadastra uma app que vai utilizar a API de Adoções.
|
|
|
|
- "testUsuario": inserir ba collection "usuarios": cadastra o primeiro usuário administrador.
|
|
|
|
- Eles são necessários para fazer o "login" na API via OAuth2.
|
|
|
|
- Sugere-se utilizar o [Postman](https://www.getpostman.com/) para testar a API REST.
|
|
|
|
- No repositório já existem arquivos criados com o [environment](http://www.tools.ages.pucrs.br/AGES-Adocoes/Adocoes/blob/d8e88d26c9dc9ea9d83b82c3e23da3222844e632/postman/adocoes.postman_environment.json) e a [collection de endpoints](http://www.tools.ages.pucrs.br/AGES-Adocoes/Adocoes/blob/d8e88d26c9dc9ea9d83b82c3e23da3222844e632/postman/adocoes.postman_collection.json) da API Adoções.
|
|
|
|
- Sugere-se utilizar o [Visual Studio Code - VS Code](https://code.visualstudio.com/) como IDE.
|
|
|
|
- O repositório já tem todos os arquivos de configuração do VS Code para build, execução em develop, homo e prod, bem como depuração passo a passo.
|
|
|
|
|
|
|
|
Veja os [layouts das telas](./layouts) do aplicativo para dispositivos móveis que já foram elaborados pelo BEPiD. Os layouts das telas serão elaborados com apoio de outras equipes. Aguardem novidades!
|
|
|
|
### Testes Unitários
|
|
|
|
|
|
|
|
Aguardem novidades!!!
|
|
|
|
|
|
|
|
### Integração Contínua
|
|
|
|
|
|
|
|
#### Funcionamento
|
|
|
|
|
|
|
|
Aguardem novidades!!!
|
|
|
|
|
|
|
|
# **IMPLEMENTAÇÃO E TESTES**
|
|
|
|
#### Testes Automáticos de Aceitação
|
|
|
|
|
|
|
|
Aguardem novidades!!!
|
|
|
|
|
|
|
|
## API REST
|
|
|
|
|
|
|
|
### Ambiente de Desenvolvimento
|
|
|
|
|
|
|
|
- Para configurar o ambiente de desenvolvimento local é necessário instalar:
|
|
|
|
- [Node.js](https://nodejs.org/en/)
|
|
|
|
- [Mongo DB](./Mongo-DB)
|
|
|
|
- RoboMongo ou outro cliente para o MongoDB
|
|
|
|
- Após instalar o MongoDB, abrir o [script para popular MongoDB](http://www.tools.ages.pucrs.br/AGES-Adocoes/Adocoes/blob/master/api/test/inicializacaoMongo.mongo) e inserir no DB os seguintes objetos iniciais:
|
|
|
|
- Após instalar o MongoDB, abrir o [script para popular MongoDB](http://www.tools.ages.pucrs.br/AGES-Adocoes/Adocoes/blob/d8e88d26c9dc9ea9d83b82c3e23da3222844e632/api/test/inicializacaoMongo.mongo) e inserir no DB os seguintes objetos iniciais:
|
|
|
|
- "testCliente": inserir na collection "clientes": cadastra uma app que vai utilizar a API de Adoções.
|
|
|
|
- "testUsuario": inserir ba collection "usuarios": cadastra o primeiro usuário administrador.
|
|
|
|
- Eles são necessários para fazer o "login" na API via OAuth2.
|
|
|
|
- Sugere-se utilizar o [Postman](https://www.getpostman.com/) para testar a API REST.
|
|
|
|
- No repositório já existem arquivos criados com o environment e a collection de endpoints da API Adoções.
|
|
|
|
- Sugere-se utilizar o Visual Studio Code (VS Code) como IDE.
|
|
|
|
- No repositório já existem arquivos criados com o [environment](http://www.tools.ages.pucrs.br/AGES-Adocoes/Adocoes/blob/d8e88d26c9dc9ea9d83b82c3e23da3222844e632/postman/adocoes.postman_environment.json) e a [collection de endpoints](http://www.tools.ages.pucrs.br/AGES-Adocoes/Adocoes/blob/d8e88d26c9dc9ea9d83b82c3e23da3222844e632/postman/adocoes.postman_collection.json) da API Adoções.
|
|
|
|
- Sugere-se utilizar o [Visual Studio Code - VS Code](https://code.visualstudio.com/) como IDE.
|
|
|
|
- O repositório já tem todos os arquivos de configuração do VS Code para build, execução em develop, homo e prod, bem como depuração passo a passo.
|
|
|
|
|
|
|
|
# **INTEGRAÇÃO E ENTREGA**
|
|
|
|
#### [Getting Started](./getting-started)
|
|
|
|
|
|
|
|
[Aqui](./getting-started) você encontra tudo que vai precisar para o setup inicial pra trabalhar no projeto.
|
|
|
|
|
|
|
|
### Testes Unitários
|
|
|
|
|
|
|
|
Aguardem novidades!!!
|
|
|
|
|
|
|
|
### Integração Contínua
|
|
|
|
|
|
|
|
#### Funcionamento
|
|
|
|
|
|
|
|
Aguardem novidades!!!
|
|
|
|
|
|
|
|
#### Testes Automáticos de Aceitação
|
|
|
|
|
|
|
|
Aguardem novidades!!!
|
|
|
|
|
|
|
|
# **PRODUTOS FINAIS**
|
|
|
|
|
|
|
|
## 1 Aplicativo
|
|
|
|
## Aplicativo Android
|
|
|
|
|
|
|
|
Aqui você terá acesso ao link para download do aplicativo para dispositivos móveis. Aguardem novidades!!!
|
|
|
|
|
|
|
|
## 2 API REST
|
|
|
|
## API REST
|
|
|
|
|
|
|
|
Aqui você terá acesso à documentação da API REST e ao lonk para download de arquivos para o Postman. Aguardem novidades!!!
|
|
|
|
|
|
|
|
# **TECNOLOGIAS, PADRÕES E PROTOCOLOS UTILIZADOS**
|
|
|
|
|
|
|
|
# 1 [Node.js](https://nodejs.org/en/)
|
|
|
|
## [Node.js](https://nodejs.org/en/)
|
|
|
|
|
|
|
|
O [Node.js](https://nodejs.org/en/) foi utilizado para o desenvolvimento da API REST.
|
|
|
|
|
|
|
|
## [Getting Started](./getting-started)
|
|
|
|
|
|
|
|
[Aqui](./getting-started) você encontra tudo que vai precisar para o setup inicial pra trabalhar no projeto.
|
|
|
|
|
|
|
|
## [Frameword IATE](./framework) (Interactor - Adapter - Translator - Entity)
|
|
|
|
|
|
|
|
Conheça nosso [framework](./framework) de desenvolvimento em Node.js.
|
|
|
|
|
|
|
|
# 2 [Mongo DB](./Mongo-DB)
|
|
|
|
## [Mongo DB](./Mongo-DB)
|
|
|
|
|
|
|
|
O [Mongo DB](https://www.mongodb.com/) é utilizado para armazenar os dados de crianças e adolescentes em condições de adoção e todos os demais dados necessários ao aplicativo.
|
|
|
|
|
|
|
|
## [Configuração do RoboMongo](./configuracao-do-robomongo)
|
|
|
|
### [Configuração do RoboMongo](./configuracao-do-robomongo)
|
|
|
|
|
|
|
|
Aprenda [aqui](./configuracao-do-robomongo) a configurar o RoboMongo para gerenciar seus bancos de dados no MongoDB.
|
|
|
|
|
|
|
|
# 3 REST
|
|
|
|
## REST
|
|
|
|
|
|
|
|
## [Minha primeira API](./minha-primeira-api)
|
|
|
|
### [Minha primeira API](./minha-primeira-api)
|
|
|
|
|
|
|
|
Veja um exemplo de como construir um API REST simples utilizando Node.js: [Minha primeira API](./minha-primeira-api).
|
|
|
|
|
|
|
|
## [Como criar uma API REST com Node.js e MongoDB](http://adrianmejia.com/blog/2014/10/01/creating-a-restful-api-tutorial-with-nodejs-and-mongodb/)
|
|
|
|
### [Como criar uma API REST com Node.js e MongoDB](http://adrianmejia.com/blog/2014/10/01/creating-a-restful-api-tutorial-with-nodejs-and-mongodb/)
|
|
|
|
|
|
|
|
Aprenda [nesse artigo](http://adrianmejia.com/blog/2014/10/01/creating-a-restful-api-tutorial-with-nodejs-and-mongodb/) como criar uma API REST com Node.js e MongoDB.
|
|
|
|
|
|
|
|
# 4 [OAuth2.0](./oauth-2.0)
|
|
|
|
## [OAuth2.0](./oauth-2.0)
|
|
|
|
|
|
|
|
O acesso à API REST do projeto obedece ao padrão de autorização de acesso [OAuth2.0](./oauth-2.0).
|
|
|
|
|
|
|
|
# 5 Android
|
|
|
|
|
|
|
|
Entenda o protocolo de autorização de acesso que será utilizado no Projeto Adoções.
|
|
|
|
|
|
|
|
## Imagens do Quadro Explicativo (Aula 11/08/17)
|
|
|
|
## Android
|
|
|
|
|
|
|
|
[Tecnologias, Algoritmo e Telas](https://image.ibb.co/dyGsXF/Foto_1.jpg)
|
|
|
|
|
|
|
|
[Scrum](https://image.ibb.co/g7KwsF/Foto_2.jpg)
|
|
|
|
Aguardem novidades!!!
|
|
|
|
|
|
|
|
# **FERRAMENTAS DE APOIO**
|
|
|
|
|
|
|
|
# 1 [Slack](http://slack.com)
|
|
|
|
|
|
|
|
[Slack](http://slack.com) é uma ferramenta de comunicação integrada para times de desenvolvimento.
|
|
|
|
|
|
|
|
# 2 [GitLab](http://www.gitlab.com)
|
|
|
|
## Ferramenta de Gerência de Artefatos de Projeto e Versionamento
|
|
|
|
|
|
|
|
[GitLab](http://www.gitlab.com) é um sistema de controle de versões baseado no Git, que permite a gerência do código de projetos com equipes distribuídas, com ênfase em velocidade. O Git foi inicialmente projetado e desenvolvido por Linus Torvalds para o desenvolvimento do kernel Linux, mas foi adotado por muitos outros projetos.
|
|
|
|
|
|
|
|
## [Comandos básicos do GitLab](./comandos-basicos-de-git)
|
|
|
|
### [Comandos básicos do GitLab](./comandos-basicos-de-git)
|
|
|
|
|
|
|
|
Aprenda os [Comandos básicos](./comandos-basicos-de-git) para poder trabalhar no GitLab.
|
|
|
|
|
|
|
|
## [Integração do GitLab com o Slack](./integracao-com-slack)
|
|
|
|
## Ferramenta de Comunicação Integrada
|
|
|
|
|
|
|
|
[Slack](http://slack.com) é uma ferramenta de comunicação integrada para times de desenvolvimento.
|
|
|
|
|
|
|
|
### [Integração do GitLab com o Slack](./integracao-com-slack)
|
|
|
|
|
|
|
|
Veja [aqui](./integracao-com-slack) como integrar o GitLab ao Slack.
|
|
|
|
|
|
|
|
# 3 [Kanban do Projeto](http://www.kanban.ages.pucrs.br/boards/projetos/Adocoes)
|
|
|
|
## Kanban do Projeto
|
|
|
|
|
|
|
|
O Projeto Adoções é acompanhado de perto através de um [kanban](http://www.kanban.ages.pucrs.br/boards/projetos/Adocoes) integrado ao GitLab.
|
|
|
|
|
|
|
|
# 4 [Wireframe.cc](https://wireframe.cc/)
|
|
|
|
## Ferramenta de Prototipação de Telas
|
|
|
|
|
|
|
|
Para construção dos mockups das telas foi utilizada a ferramenta [Wireframe.cc](https://wireframe.cc/).
|
|
|
|
|
|
|
|
# 5 Astah
|
|
|
|
## Ferramenta de Modelagem
|
|
|
|
|
|
|
|
Aguardem novidades!!!
|
|
|
|
[Astah](http://astah.net/)
|
|
|
|
|
|
|
|
# 6 Ferramentas de teste automatizado e de integração contínua
|
|
|
|
## Ambientes de Desenvolvimento
|
|
|
|
|
|
|
|
O projeto Adoções empregará técnicas de teste automatizado e integração contínua.
|
|
|
|
### Para a API REST
|
|
|
|
|
|
|
|
Algumas ferramentas avaliadas foram:
|
|
|
|
[Visual Studio Code - VS Code](https://code.visualstudio.com/)
|
|
|
|
|
|
|
|
## 6.1 [Circle CI](./teste-deploy:-circleci)
|
|
|
|
### Para o aplicativo Android
|
|
|
|
|
|
|
|
## 6.2 [Mocha e Expect](./teste:-mocha-e-expect.js)
|
|
|
|
[Android Studio](https://developer.android.com/studio/index.html?hl=pt-br)
|
|
|
|
|
|
|
|
# 7 [Postman](https://www.getpostman.com/)
|
|
|
|
## Ferramentas e Frameworks de Teste
|
|
|
|
|
|
|
|
Aguardem novidades!!!
|
|
|
|
### Para a API REST
|
|
|
|
|
|
|
|
[Mocha e Expect](./teste:-mocha-e-expect.js)
|
|
|
|
[Postman](https://www.getpostman.com/)
|
|
|
|
|
|
|
|
# 8 Android Studio
|
|
|
|
### Para o aplicativo Android
|
|
|
|
|
|
|
|
Aguardem novidades!!!
|
|
|
|
|
|
|
|
## Frameworks de Integração Contínua
|
|
|
|
|
|
|
|
[Jenkins](https://jenkins.io/) |
