Skip to content

Latest commit

 

History

History
478 lines (393 loc) · 18.1 KB

README.md

File metadata and controls

478 lines (393 loc) · 18.1 KB

Conteúdo desse documento


Sobre


O ConvêniosBR é um projeto open source que visa criar uma solução compatível com as plataformas iOS e Android para monitorar os convênios firmados pelo governo federal, através dele o cidadão pode:

  • Listar os convênios existentes na sua localidade (região, estado, municipio)
  • Ver informações especificas de um determinado convênio
  • Monitorar um convênio e receber atualizações de status
  • Denunciar irregularidades em um determinado convênio a partir da plataforma e-OUV.
  • Receber via email relatórios dos convênios monitorados
  • Acessar gráficos e outras informações estatísticas sobre um proponente ou convênio.
  • Efetuar pesquisas por texto ou voz para encontrar um determinado convênio
  • Efetuar filtros nas informações dispostas no APP
  • Postar comentários e fotos sobre um convênio ou consultar os comentários e fotos postados por outros usuários
  • Visualizar informações financeiras de um convênio
  • Visualizar o cronograma de atividades de um convênio
  • Visualizar informações sobre o concedente, proponente e interveniente
  • Compartilhar as informações de um determinado convênio via Facebook, Twitter, Email e Whatsapp
  • Acessar a versão acessível do ConvêniosBR

O acesso ao aplicativo é livre, entretanto para algumas funções será necessário o cadastro do usuário, esse cadastro pode ser feito a partir do formulário de inscrição disponível ou a partir do login via Facebook.

Serão disponibilizadas para o Governo Federal/Ministério da Justiça em formato de relatório automático mensal as seguintes informações:

  • Perfil do cidadão/usuário

    • Município/estado onde reside
    • Idade
    • Sexo
  • Convênios

    • Lista dos principais convênios monitorados
    • Lista de todos os convênios denunciados
    • Comentários e fotos por convênio
    • Informações estatísticas sobre os convênios monitorados e denunciados, tais como: principais proponentes, concedentes, valor aplicado, etc.

Integração com a API Dados Abertos SICONV

Os dados exibidos nesse projetos são extraídos a partir da API Dados Abertos SINCONV, no momento essa funcionalidade está em implantação, usando apenas uma base parcial de dados.

Acessibilidade

O projeto detecta automaticamente quando o usuário possui um recurso de acessibilidade ativado (como o VoiceOver), e a partir desse momento exibe uma navegação em texto no lugar de imagens e ícones, permitindo que pessoas deficientes possam utilizar normalmente o ConvêniosBR, também foi adicionado a busca por voz para facilitar busca de informações dentro do aplicativo.

Instalando e configurando


Caso você deseje apenas visualizar o projeto num smartphone Android baixe o APK (android-x86-debug.apk) disponível em platforms/android/build/outputs/apk, para versão web acesse esse link.

Caso você não saiba realizar a instalação de um arquivo apk no seu Android acesse esse link para maiores informações.

Clone este repositório.

git clone https://github.com/rxluz/ConveniosBR.git.

Instale o Ionic CLI e Cordova

npm install -g ionic cordova gulp

Pacotes Node e Bower

npm install
ionic state restore
bower install

Executar versão para web

ionic serve

Executando a versão para Android

Dentro do projeto existe na pasta platforms/android/build/outputs/apk os executáveis para que o projeto possa ser executado no Android (android-x86-debug.apk).

Executando a versão para iOS

Dentro do projeto existe na pasta platforms/ios/ existe o arquivo ConveniosBR.xcodeproj, como ele é possível abrir o projeto dentro do Xcode e executar em qualquer dispositivo ou simulador iOS, o arquivo funciona somente se todo o conteúdo da pasta aonde ele está presente for baixado.

Desenvolvimento

O ConvêniosBR é desenvolvido utilizando o framewok opensource Ionic 1.2, o código fonte para alterações está na pasta www/, recomenda-se o conhecimento de Angular 1.3+, Sass e Apache Cordova.

A partir do Ionic é gerado um código nativo para a plataforma Android e iOS.

Interfaces do projeto


Os screenshots abaixo não contém informações reais, servindo apenas como referência de layout e UX do projeto

Ícone e apresentação

Ícone

Splash screen

Apresentação 1 (onboarding)

Apresentação 2 (onboarding)

Apresentação 3 (onboarding)

Login, notificações, menu

Identificação (Login)

Inscrição

Sistema de notificações

Menu de opções rápidas

Menu deslogado

Menu logado

Opções do usuário

Editar perfil

Alterar senha

Cancelar conta

Home, dicas e sistema de busca

Tela principal (home)

Sistema de dicas

Formulário de busca

Busca por voz

Resultados da busca

Informações de um convênio

Visualização inicial do convênio e gráfico de cronograma de gastos

Gráfico convênios desse proponente

Abas de concedente, proponente e interveniente e justificativa do convênio

Principais comentários para um convênio

Opção para denunciar um convênio

Informações financeiras de um convênio (inicio)

Informações financeiras de um convênio (fim)

Cronograma de atividades de um convênio

Lista de todos os comentários de um convênio

Marcar um comentário como impróprio

Compartilhar as informações do convênio

Outras interfaces

Envio de feedback e solicitação de suporte

Sobre o ConvêniosBR (inicio)

Sobre o ConvêniosBR (fim)

Colaboradores do ConvêniosBR

Status do desenvolvimento


Desenvolvimento consolidado

Os seguintes itens já tiveram o seu desenvolvimento concluído:

id nome prioridade
1 Identificação via email e senha Alta
2 Identificação via facebook Média
3 Formulário de inscrição integrado ao Facebook Alto
4 Alterar minha senha Alto
5 Sair Alto
6 Notificações internas (toast) Alto
7 Interfaces bem-vindo (onboarding) Média
8 Lista de convênios próximo (home) Alto
9 Lista de convênios monitorados Alto
11 Sistema de dicas (tips) Média
12 Busca por voz Média
13 Menu Alta
14 Informações gerais do convênio Alta
15 Gráfico Cronograma de Gastos Média
15 Gráfico Convênios do Proponente por ano Média
16 Informações financeiras do convênio Média
17 Cronograma do convênio Média
18 Compartilhar o convênio no Facebook, Twitter, Whatsapp e Email Média
19 Visualizar os comentários Alta
20 Feedback e suporte Alta
20 Sobre o ConvêniosBR Baixa
20 Lista de colaboradores Baixa

Desenvolvimento em andamento

id nome prioridade
21 Consolidação da identidade visual, padronização de cores e estilos das interfaces Média
22 Integração com a API Dados Abertos Sinconv Alta
23 Algoritmo da Busca Alta
24 Filtrar resultados Alta
25 Consolidação da acessibilidade em todas as interfaces Alta
26 Envio do email de monitoramento para usuários inscritos Alta
26 Gerenciar comentários (adicionar, gostar, denunciar, excluir) Alta
27 API para o banco de dados de informações especificas Alta
27 API para o banco de dados de informações especificas Alta
28 Vídeo de divulgação do projeto Média
29 Redes sociais Média

Bugs conhecidos

id nome prioridade
1 Ao clicar em um botão o botão pode ficar invisível Alta
2 O teclado não é exibido quando a busca é exibida ou permanece ligado apos a busca ser finalizada Alta
3 O menu de opções rápidas aparece em interfaces internas Média
3 Ao clicar em um convênio as vezes o mesmo não é carregado Alta
4 Os gráficos não são exibidos quando se aciona um segundo convênio (é necessário fechar o aplicativo e abrir novamente) Alta
4 O titulo de algumas interfaces aparece descentralizado Média
5 As opções de login e inscreva-se aparecem na tela de apresentação mesmo que o usuário esteja logado Alta
6 Ao clicar em compartilhar a tela de compartilhamento as vezes aparece duplicada Alta
7 O botão curtir aparece ativado para todos os comentários Alta
8 A opção fechar informações sobre status da acessibilidade não funciona corretamente Média