Citizen Participation and Open Government Application
This is the opensource code repository of the eParticipation website CONSUL, originally developed for the Madrid City government eParticipation website
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 the current features in features or docs and future features in the open issues list. For current status on upcoming features go to Roadmap
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.
NOTE: For more detailed instructions check the docs
Prerequisites: install git, Ruby 2.3.2, bundler gem, 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
bin/rake db:setup
bin/rake db:dev_seed
RAILS_ENV=test rake db:setup
Run the app locally:
bin/rails s
Prerequisites for testing: install PhantomJS >= 2.1.1
Run the tests with:
bin/rspec
If you add SCSS code you can check it with:
scss-lint
To maintain accesibility level, if you add new colors use a Color contrast checker (WCAG AA is mandatory, WCAG AAA is recommended)
If you work on Coffeescript code you can check it with coffeelint (install with npm install -g coffeelint) :
coffeelint .
You can use the default admin user from the seeds file:
user: [email protected] pass: 12345678
But for some actions like voting, you will need a verified user, the seeds file also includes one:
user: [email protected] pass: 12345678
Read more on documentation:
- English: CUSTOMIZE_EN.md
- Spanish: CUSTOMIZE_ES.md
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.
Code published under AFFERO GPL v3 (see LICENSE-AGPLv3.txt)
See CONTRIBUTING.md
If you want to use CONSUL logo you can download the guidelines which contains a use guide and different versions and sizes of the logo.