amaia / consul

Consul - Open Government and E-Participation Web Software

![Logo of Consul] (https://raw.githubusercontent.com/consul/consul/master/public/consul_logo.png)

Consul

Citizen Participation and Open Government Application

This is the opensource code repository of the eParticipation website originally developed for the Madrid City government eParticipation website

Current state

Development started on 2015 July 15th. Code was deployed to production on 2015 september 7th to decide.madrid.es. Since then new features are added often. You can take a look at a roadmap and future features in the open issues list.

Roadmap

See ROADMAP_ES.md

Tech stack

The application backend is written in the Ruby language using the Ruby on Rails framework.

Frontend tools used include SCSS over Foundation for the styles.

Configuration for development and test environments

Prerequisites: install git, ImageMagick, Ruby 2.2.3, bundler gem, ghostscript and PostgreSQL (>=9.4).

git clone https://github.com/consul/consul.git
cd consul
bundle install
cp config/database.yml.example config/database.yml
cp config/secrets.yml.example config/secrets.yml
rake db:create
bin/rake db:setup
bin/rake db:dev_seed
RAILS_ENV=test bin/rake db:setup

Run the app locally:

bin/rails s

Prerequisites for testing: install PhantomJS >= 1.9.8

Run the tests with:

bin/rspec

You can use the default admin user from the seeds file:

user: [e-mail] pass: 12345678

But for some actions like voting, you will need a verified user, the seeds file also includes one:

user: [e-mail] pass: 12345678

OAuth

To test authentication services with external OAuth suppliers - right now Twitter, Facebook and Google - you'll need to create an "application" in each of the supported platforms and set the key and secret provided in your secrets.yml

In the case of Google, verify that the APIs Contacts API and Google+ API are enabled for the application.

Licence

Code published under AFFERO GPL v3 (see LICENSE-AGPLv3.txt)

Contributions

See CONTRIBUTING_EN.md