Construindo a aplicação

Construindo a aplicação

Baixando o código fonte

git clone git@github.com:sibbr/explorador.git

Configurar o explorador

• Dependências

É importante lembrar que o explorador depende de um projeto responsável pela customização básica: cabeçalho, rodapé e todo o estilo (styling) da aplicação.

Para tal, clone o repositório web-theme:

git clone git@github.com:sibbr/web-theme.git

Propriedades

1. Crie o arquivo 'config/production/portal-config.properties' baseado no arquivo de exemplo 'portal-config.properties.example' utilizando os seus parâmetros.

Aqui, as configurações mais importantes a se observar e adaptar para uma customização são:

• Idioma - idiomas suportados
• Conexão ao banco de dados - parâmetros de conexão à base de dados
• Servidor de e-mail - parâmetros de conexão ao servidor de e-mail para envio de mensagens aos usuários
• Tile-server - parâmetros de conexão ao tile-server para projeção dos pontos no mapa

2. Habilite o log, isto porde ser útil se a aplicação não estiver operando como o esperado. Crie o arquivo 'src/main/resources/log4j.properties' baseado no arquivo 'log4j.properties.example'.

3. O arquivo 'config/production/version.properties' é utilizado para armazenar a versão da aplicação. Este arquivo será automaticamente produzido pelo script Gradle quando a opção 'buildProduction' for utilizada. A versão da aplicação será utilizada para acessar recursos como arquivos JavaScript e CSS. Isto irá obrigar os navegadores a pegar a versão mais atual dos arquivos sempre que uma nova versão da aplicação for compilada.

Compilando o código

É necessário tanto o maven quanto o gradle instalados para construir o código da aplicação.

Gradle

O explorador utiliza o Gradle como ferramenta de gestçai de construção. A versão sugerida é a 1.10+. Para instalar o gradle em distribuições GNU/Linux baseadas em Ubuntu:

sudo aptitude install gradle

Testes

Para realizar os testes unitários, basta executar no terminal o seguinte comando, no diretório raiz do projeto explorador:

gradle clean test

É possível realizar testes de integração e executar alguns testes automatizados em uma janela do navegador (Firefox). O Firefox deve estar instalado na máquina em que os testes de integração sejam executados. Atualizações do navegador podem quebrar alguns testes, especialmente quando envolvem JavaScript. Às vezes, o processo Gradle pode falhar em encerrar quando os testes terminarem de executar. Para executar os testes de integração, execute no terminal:

gradle clean --daemon runIntegrationTest

Construção (build)

Para construir a aplicação, basta executar no terminal o seguinte comando, no diretório raiz do projeto explorador:

gradle clean buildProduction

O código compilado estará comprimido no arquivo build/explorador.war. Mova este arquivo para o diretório webapps do servidor tomcat e a aplicação subirá no endereço http://localhost:port/explorador, de acordo com as configurações do seu Tomcat.

Uma alternativa prática para o ambiente de desenvolvimento é a utilização do script deploy. Abra o arquivo, e edite de acordo com as suas configurações de ambiente.

O script conta com um --help que descreve a sua utilização. Este script realiza as seguintes funções:

1. Derruba o servidor tomcat da aplicação, caso esteja ligado
2. Compila o código
3. Remove arquivos temporários e de trabalho do build anterior do servidor tomcat
4. Move o .war compilado do diretório target/ para o diretório webapps/ do servidor tomcat
5. Reinicia o servidor tomcat
6. Limpa o cache do servidor redis local

Para executar o script deploy, no terminal:

sh deploy

'Observação: Durante a compilação(2), o processo pede uma confirmação no console sobre a versão do projeto, que o usuário deve responder usando o teclado, com "y" para prosseguir, ou "n" para cancelar.'