README.md

Projeto para o Desafio CEPESP

Desafio

Detalhes do desafio est�o mantidos em: desafio de implementa��o.

• Nome da Equipe: ufcat

• Participantes: Ricardo (l�der), Gabriel, Luis, Marco T�lio (graduado), Dimas

• Perfil da Equipe: professor e alunos de disciplina de gradua��o em Ci�ncia da Computa��o, complementado com um graduado.

• Descri��o do projeto a desenvolver

  • A aplica��o prover� pesquisas em resultados eleitorais baseadas em localiza��o sem�ntica est�tica (divis�es administrativas) e din�mica (territ�rios baseados em crit�rios sociais de acordo com o IBGE), e oferecer� um frontend composto de uma aplica��o baseada em mapas que permitir� simula��es e um backend que oferecer� as pesquisas utilizando uma API RESTful. Aplica��o frontend oferer� ainda interface espec�fica para eleitores, ajudando na avalia��o do efeito do voto na elei��o de fato e promovendo simula��es. A solu��o integrar� dados do IBGE, TSE (n�o inclu�dos no CEPESPData), bases de mapas abertas, al�m do pr�prio CEPESPData.

Execução da Aplicação

Requisitos

• Ruby (acima de 2.2)
• Rails (versão 5)
• Executar o bundle install para instalar eventuais dependências.

Cache de dados

A aplicação utiliza cache dinâmico em dois níveis. Para que não haja muitos problemas para testar a aplicação, sugere-se que se baixe um cache utilizado nos testes de desenvolvimento e disponível no arquivo <goo.gl/ME8b5E> (50Mb). O arquivo deve ser descompactado no diretório rails/tmp (é um arquivo tgz - TAR com GZIP).

A aplicação funciona mesmo sem esse cache.

Execução

A aplicação encontra-se em modo de desenvolvimento. Para executá-la, deve-se digitar de dentro do diretório rails:

rails server

A aplicação ficará disponível em http://localhost:3000/, considerando que o acesso será feito na mesma máquina de execução da aplicação.

Implementa��o proposta

• Ver documenta��o das interfaces da aplica��o, que indica tanto aspectos da interface gr�fica como dos componentes internos.
• ver documenta��o projeto implementa��o

Ferramentas

• Ruby: utilizar vers�o acima da vers�o 2.3, preferencialmente. N�o utilizar Ruby em vers�es menores que 2.0.

• Slack: comunica��o entre os participantes

• Issue tracker: registro de problemas no pr�prio gitlab, ao menos por enquanto

Tarefas

• Gabriel: interface com a API IBGE em https://servicodados.ibge.gov.br/api/docs
• Luis: interface com a API REST do CEPESP.io em https://github.com/Cepesp-Fgv/cepesp-rest
• Ricardo: projeto da solu��o e a API de consultas.

Manuais que podem ajudar

• Escrita de documentos em markdown no Gitlab (como este documento): https://gitlab.com/help/user/markdown.md
• Uso do Git https://gitlab.com/help#git-and-gitlab