Skip to content

Latest commit

 

History

History
123 lines (72 loc) · 6.53 KB

README.md

File metadata and controls

123 lines (72 loc) · 6.53 KB
Raw

Merenda+

License: GPL

2017.2 - Merenda+ - Auxílio aos Conselheiros do Conselho de Alimentação Escolar (CAE).

O Merenda+ é uma aplicação mobile, que auxilia o conselheiro nas tarefas pertinentes a assuntos sobre a fiscalização da merenda escolar de determinada escola da sua região de atuação, de modo que as atividades realizadas - desde o planejamento da visita até a consolidação dos dados - possam ser executadas de forma mais ágil e intuitiva do que como é efetuada atualmente - a mão, através de “caneta e papel” -.

Outro olhar também se aplica a esse projeto ao analisar o fato de que este oferece informações relevantes a respeito das fiscalizações ao Tribunal de Contas da União (TCU), que por sua vez analisará estes dados a fim de encontrar anomalias que possam prejudicar de qualquer forma a distibuição da merenda escolar ao alunos da rede pública de ensino.

O sistema foi inicialmente desenvolvido por estudantes do curso de Engenharia de Software da UnB-Gama como projeto das disciplinas Método de Desenvolvimento de Software e Gerência de Gestão de Portifólios e Projetos de Software.

Se tem o interesse em contribuir para a Merenda+, confira o guia de contribuições.

Acesso à Aplicação

Para realizar o acesso a aplicação na versão atual mais estável deve-se seguir os seguintes passos:

  1. Instalar o EXPO no seu aparelho mobile:

  2. Acessar o link da aplicação na barra de pesquisa ou ler o QRCode abaixo:

    • Link da Aplicação: https://expo.io/@rogerlenke/merendamais

    • QRCode:

  1. Caso queira, veja um vídeo da aplicação no YouTube

  2. Desfrute, se você for um Conselheiro 😉;

Resumo Arquitetural

A aplicação é formada por 2 camadas principais:

Para entender a arquitetura com mais detalhes acesse o Documento de Arquitetura do projeto e os repositórios de cada camada.

Instalação

Os comandos abaixo foram voltados para usuários que utilizam o sistema operacional Linux. Dessa forma, o primeiro passo para a instalação do projeto é baixar o repositório com o seguinte comando:

git clone https://github.com/fga-gpp-mds/2017.2-MerendaMais.git

Após clonar o repositório, configure o ambiente para a execução de projetos que utilizem React Native. Para seguir um pequeno tutorial clique aqui.

Após configurar o ambiente, entre na pasta do projeto e rode os seguintes comandos:

  • Para instalar as dependências do projeto:

npm install

  • Para gerar o QRCode de feedback instantâneo do React Native e ver as mudanças do código em tempo real:

npm start

Docker

A equipe não utilizou Docker durante o desenvolvimento, pois como os membros já estavam com o ambiente configurado não houve necessecidade de utilizá-lo. Porém caso não deseje configurar o ambiente, recomenda-se utilizar o Docker pois ele faz toda a configuração de ambiente automáticamente. Para utilizá-lo deve-se ter o Docker e o Docker-compose instalados.

Após instalar o Docker e o Docker-compose, entre na pasta do projeto e rode o seguinte comando no terminal e o projeto já estará funcionado:

  • Para subir o ambiente do projeto:

Docker-compose up

  • Para parar o docker de rodar:

Ctrl+c

Caso deseje instalar alguma dependência no package.json ou acessar o container via bash, rode os seguintes comandos no terminal, depois de ter seguido o passo anterior:

  • Para iniciar o container:

docker start 20172merendamais_merenda_mais_1

  • Para executar o docker via bash:

docker exec -it 20172merendamais_merenda_mais_1 bash

  • Para sair do bash do container:

Ctrl+d

  • Para parar a execução do container:

docker stop 20172merendamais_merenda_mais_1

Principais funcionalidades

  • Manter Conselheiro;
  • Realizar denúncia;
  • Anexar arquivos;
  • Consultar informações sobre a cartilha do Conselheiro, legislação e reuniões efetuadas;
  • Agendar visita;
  • Agendar reunião;
  • Convidar conselheiros para eventos;
  • Convida um agente da vigilância sanitário para a visita em uma escola;
  • Pesquisar escola;
  • Acessar dados de visitas;
  • Acessar relatórios de fiscalizações;
  • Gerenciar registros de Conselheiros;

Como contribuir

Os contribuintes podem colaborar para manter e evoluir o sistema através da correção de bugs e implementação de novas funcionalidades, que estão listados na pipeline "Opened Issues" no zenhub Boards. Para contribuir, o projeto deve ser clonado do repositório oficial.

Documentação

Toda a documentação pode ser acessada através da Wiki do projeto.