bb958daf05
Using links combined with JavaScript to generate POST requests to the browser has a few issues. An obvious one is that it doesn't work for users without JavaScript enabled (which lately I've noticed are more common than I thought, even though I've been one of them for years). These users will reach a 404 page. Since CONSUL isn't currently designed to work without JavaScript enabled, let's ignore this one for now. A not so obvious issue is screen reader users might expect the link to take them somewhere instead of performing an action (in this case, sending a form to the server). There might be more issues I'm unaware of. Quoting DHH [1]: "Turning ahrefs into POSTs is a bit of an anti-pattern, especially for a11y reasons. Better to use button_to with a styling." So we're using a button instead. This way we can also simplify the code and make the button disabled for unidentified users, which automatically makes it impossible to focus it using the keyboard. A possible disadvantage of using `button_to` is it will create a form tag which will be announced to screen readers as a form landmark. I've tested it with my screen reader and everything worked fine for me, but some screen reader users might interact with these forms in a different way and find it confusing, particularly in the case where the button is disabled. With this change, we're only changing links for buttons in one place. There are other places where we should do similar changes. [1] See issue 33 in https://github.com/hotwired/turbo-rails/
CONSUL
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
Documentation
Check the ongoing documentation at https://docs.consulproject.org 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.
CONSUL Project main website
You can access the main website of the project at http://consulproject.org where you can find documentation about the use of the platform, videos, and links to the community space.
Configuration for development and test environments
NOTE: For more detailed instructions check the docs
Prerequisites: install git, Ruby 2.6.7, CMake, pkg-config, shared-mime-info, Node.js and PostgreSQL (>=9.5).
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
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
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.
License
Code published under AFFERO GPL v3 (see LICENSE-AGPLv3.txt)
Contributions
See CONTRIBUTING.md