README.md

Website (beta)

Sobre

Este website permite recolher informação sobre as rendas dos quartos e casas de Coimbra. O objectivo é fornecer dados e estatísticas sobre os preços das rendas, que ajudem os cidadãos a tomar melhores decisões e analisar a realidade imobiliária da cidade.

Este é um projecto desenvolvido no Improve Coimbra, um evento mensal com o objectivo de encontrar e implementar soluções para melhorar Coimbra.

Desenvolvimento

Informações importantes sobre esta aplicação/repositório.

Tecnologias

• Ruby on Rails
• MongoDB
• SASS (CSS)
• jQuery (Javascript)

Development

Para executar a aplicação em ambiente de desenvolvimento local são necessários os seguintes passos:

• Fazer clone do repositório e correr o comando bundle install para instalar as dependências
• Instalar o mongodb, se ainda não estiver instalado
• Criar a pasta para a base de dados, correndo mkdir db/rendas_dev/ na root do projecto
• Iniciar o servidor de mongodb com o comando mongod --dbpath db/rendas_dev/
• Correr o comando rake load_postal_codes para importar os códigos postais do ficheiro coimbra_cp.txt para a base de dados (pode demorar algum tempo)
• Correr o comando rails server para iniciar o servidor
• Aceder a http://localhost:3000

Produção

Para a execução desta aplicação em ambiente de produção é necessário definir as seguintes variáveis de ambiente:

• SECRET_TOKEN (do Ruby on Rails)
• ADMIN_PASSWORD (password de acesso à zona de administração, o username é "admin")
• MONGODB_HOST (servidor de base de dados MongoDB)
• MONGODB_DATABASE (nome da base de dados MongoDB)
• MONGODB_USERNAME (utilizador da base de dados MongoDB)
• MONGODB_PASSWORD (password do utilizador da base de dados MongoDB)
• NEW_RELIC_LICENSE_KEY (licença de utilização do New Relic para a monitorização da aplicação)