Consul - Open Government and E-Participation Web Software
Ruby HTML CSS CoffeeScript JavaScript Dockerfile
voodoorai2000 Remove unused cleanup section
Contributors seem to prefer concrete issues rather that general cleanup guidelines
Removing to make CONTRIBUTING.md more succinct and helpful
Latest commit 8eb8bb9 Jul 31, 2018
Permalink
Failed to load latest commit information.
.github Add issue template Jul 4, 2018
app Fixes logo header on devise layout Jul 31, 2018
bin Regenerate bin stubs Feb 6, 2018
config Adds description to all admin settings Jul 31, 2018
db Merge pull request #2809 from wairbut-m2c/backport/translatable-conte… Jul 27, 2018
doc updates texts for investments Jan 19, 2018
lib Removes rake task to send proposal notifications Jul 26, 2018
log initial commit Jul 15, 2015
public Remove brand guidelines from readme on to decide.es website Sep 13, 2017
scripts Docker/docker-compose enhancements Jun 1, 2018
spec Updates text on admin notifications spec Jul 31, 2018
vendor/assets Remove all white spaces Sep 6, 2017
.codeclimate.yml Exclude /vendor folder from Code Climate Dec 8, 2017
.coveralls.yml integrates coveralls with travis Aug 5, 2015
.editorconfig Avoid final new empty lines on yml translation files Nov 13, 2017
.gitignore Ignores relative to the editor moved from gitignore to gitignore_global Jun 3, 2018
.mdlrc Add markdownlinter config file Jun 14, 2017
.rspec do not include foobar in rspec by default Aug 28, 2015
.rubocop.yml Disable DynamicAttributeDefinedStatically cop Apr 4, 2018
.rubocop_todo.yml Enable rubocop Performance/RedundantMatch cop & fix issues Feb 10, 2018
.ruby-version upgrade to ruby 2.3.2 Nov 19, 2016
.scss-lint.yml fixes scss lint warnings Jun 16, 2017
.travis.yml Configure Travis CI to use Chrome addon, install ChromeDriver Mar 27, 2018
CHANGELOG.md Update changelog for release v0.16 Jul 20, 2018
CODE_OF_CONDUCT.md Update Code of Conduct to contributor covenant 1.4 Jul 9, 2017
CODE_OF_CONDUCT_ES.md Update spanish Code of Conduct to 1.4 Aug 17, 2017
CONTRIBUTING.md Remove unused cleanup section Jul 31, 2018
CONTRIBUTING_ES.md Remove gemnasium references, service just shut down May 15, 2018
Capfile updates capistrano scm config Mar 14, 2017
Dockerfile Use ChromeDriver 2.40 when building container Jul 16, 2018
Gemfile updates sprockets Jul 11, 2018
Gemfile.lock updates sprockets Jul 11, 2018
Gemfile_custom changed advanced filter from budgets to budgets/investments Jan 22, 2018
LICENSE-AGPLv3.txt changes license to Affero GPL version 3 Aug 12, 2015
README.md Update README May 23, 2018
README_ES.md Remove gemnasium references, service just shut down May 15, 2018
Rakefile knapsack_pro setup Dec 5, 2017
coffeelint.json Add coffeelint configuration file Jun 14, 2017
config.ru initial commit Jul 15, 2015
crowdin.yml Correctly configure valencian (spanish) lang name for crowdin Jan 19, 2018
docker-compose.yml Docker/docker-compose enhancements Jun 1, 2018
knapsack_rspec_report.json Regenerate knapsack report Jul 18, 2018

README.md

CONSUL logo

CONSUL

Citizen Participation and Open Government Application

Build Status Code Climate 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 CONSUL, 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 at the project's website and future features at the Roadmap and open issues list.

Configuration for development and test environments

NOTE: For more detailed instructions check the docs

Prerequisites: install git, Ruby 2.3.2, bundler gem, Node.js 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:create
bin/rake db:migrate
bin/rake db:dev_seed
RAILS_ENV=test rake db:setup

Run the app locally:

bin/rails s

Prerequisites for testing: install ChromeDriver >= 2.33

Run the tests with:

bin/rspec

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

Configuration for production environments

See installer

Documentation

Check the ongoing documentation at https://consul_docs.gitbooks.io/docs/content/ to learn more about how to start your own CONSUL fork, install it, customize it and learn to use it from an administrator/maintainer perspective. You can contribute to it at https://github.com/consul/docs

License

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

Contributions

See CONTRIBUTING.md