Skip to content
Consul - Open Government and E-Participation Web Software
Branch: master
Clone or download
Pull request Compare This branch is 400 commits ahead, 7594 commits behind consul:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
app
bin
config
db
doc
lib
log
public
spec
vendor/assets
.codeclimate.yml
.coveralls.yml
.editorconfig
.gitignore
.mdlrc
.rspec
.rubocop.yml
.rubocop_todo.yml
.ruby-version
.scss-lint.yml
.travis.yml
CHANGELOG.md
CODE_OF_CONDUCT.md
CODE_OF_CONDUCT_ES.md
CONTRIBUTING.md
CONTRIBUTING_ES.md
CUSTOMIZE_EN.md
CUSTOMIZE_ES.md
Capfile
Gemfile
Gemfile.lock
Gemfile_custom
LICENSE-AGPLv3.txt
README.md
README_ES.md
Rakefile
coffeelint.json
config.ru
crowdin.yml
knapsack_rspec_report.json

README.md

Logo of Consul

Consul

Citizen Participation and Open Government Application

Build Status Code Climate Dependency Status Coverage Status Crowdin License: AGPL v3

Accessibility conformance A11y issues checked with Rocket Validator

Join the chat at https://gitter.im/consul/consul PRs Welcome

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 the current features in features or docs and future features in the open issues list. For current status on upcoming features go to Roadmap

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

NOTE: For more detailed instructions check the docs

Prerequisites: install git, Ruby 2.3.2, 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
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: admin@consul.dev pass: 12345678

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

user: verified@consul.dev pass: 12345678

Customization

Read more on documentation:

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.

License

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

Contributions

See CONTRIBUTING.md

You can’t perform that action at this time.