baefc249f0
While Rails provides a lot of functionality by default, there's one missing piece which is present in frameworks like Django or Phoenix: the so-called "view models", or "components". It isn't easy to extract methods in a standard Rails view/partial, since extracting them to a helper will make them available to all views, and so two helper methods can't have the same name. It's also hard to organize the code in modules, and due to that it's hard to figure out where a certain helper method is supposed to be called from. Furthermore, object-oriented techniques like inheritance can't be applied, and so in CONSUL customizing views is harder that customizing models. Components fix all these issues, and work the way Ruby objects usually do. Components are also a pattern whose popularity has increased a lot in the last few years, with JavaScript frameworks like React using them heavily. While React's components aren't exactly the same as the components we're going to use, the concept is really similar. I've always liked the idea of components. However, there wasn't a stable gem we could safely use. The most popular gem (cells) hasn't been maintained for years, and we have to be very careful choosing which gems CONSUL should depend on. The view_component gem is maintained by GitHub, which is as a guarantee of future maintenance as it can be (not counting the Rails core team), and its usage started growing after RailsConf 2019. While that's certainly not a huge amount of time, it's not that we're using an experimental gem either. There's currently a conflict between view_component and wicked_pdf. We're adding a monkey-patch with the fix until it's merged in wicked_pdf.
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.5.8, 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
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