/decidim

The participatory democracy framework. A generator and multiple gems made with Ruby on Rails

Primary LanguageRubyGNU Affero General Public License v3.0AGPL-3.0

Decidim Logo

The participatory democracy framework.

Free Open-Source participatory democracy, citizen participation and open government for cities and organizations

Decidim is a participatory democracy framework, written in Ruby on Rails, originally developed for the Barcelona City government online and offline participation website. Installing these libraries will provide you a generator and gems to help you develop web applications like the ones found on example applications or like our demo application.

All members of the Decidim community agree with Decidim Social Contract or Code of Democratic Guarantees.


Gem Gem GitHub contributors Yard Docs Gitter

Code quality

Build Status Maintainability Crowdin Inline docs Accessibility issues HTML issues


What do you need to do?


Getting started with Decidim

TLDR: install gem, generate a Ruby on Rails app, enjoy.

gem install decidim
decidim decidim_application

We've set up a guide on how to install, set up and upgrade Decidim. See the Getting started guide.

How to contribute

See Contributing.

Browse Decidim

After you create a development app (bundle exec rake development_app), you have to switch to it and boot the rails server with cd development_app && bundle exec rails s.

After that, you can:

  • Browse the main interface at http://localhost:3000, and log in as: user@example.org | decidim123456
  • Browse the admin interface at http://localhost:3000/admin, and log in as: admin@example.org | decidim123456
  • Browse the system interface at http://localhost:3000/system, and log in as: system@example.org | decidim123456

Also, if you want to verify yourself against the default authorization handler use a document number ended with "X".

Modules

Official (stable)

Module Description
API Exposes a GraphQL API to programatically interact with the Decidim platform via HTTP.
Accountability Adds an accountability section to any participatory space so users can follow along the state of the accepted proposals.
Admin Adds an administration dashboard so users can manage their organization and all other entities.
Assemblies Permanent participatory spaces.
Blogs This component makes possible to add posts ordered by publication time to spaces.
Budgets Adds a participatory budgets system to any participatory space.
Comments The Comments module adds the ability to include comments to any resource which can be commentable by users.
Conferences This module will be a configurator and generator of Conference pages, understood as a collection of Meetings, with program, inscriptions and categories
Consultations This module creates a new space for decidim to host consultations: debates around critical questions and a proxy for eVoting
Core The basics of Decidim: users, organizations, etc. This is the only required engine to run Decidim, all the others are optional.
Debates The Debates module adds debate to any participatory process. It adds a CRUD engine to the admin and public view scoped inside the participatory process.
Dev Aids the local development of Decidim's components.
Generators It helps you with generating decidim applications & new components. It provides the decidim executable.
Initiatives Initiatives is the place on Decidim's where citizens can promote a civic initiative. Unlike participatory processes that must be created by an administrator, Civic initiatives can be created by any user of the platform.
Meetings The Meeting module adds meeting to any participatory space. It adds a CRUD engine to the admin and public view scoped inside the participatory space.
Pages The Pages module adds static page capabilities to any participatory space. It basically provides an interface to include arbitrary HTML content to any step.
Participatory Processes The main concept of a Decidim installation: participatory processes.
Proposals The Proposals module adds one of the main components of Decidim: allows users to contribute to a participatory space by creating proposals.
Sortitions This component makes possible to select randomly a number of proposals among a set of proposals (or a category of proposals within a set) maximizing guarantees of randomness and avoiding manipulation of results by the administrator.
Surveys Adds the ability for admins to create arbitrary surveys.
System Multitenant Admin to manage multiple organizations in a single installation.
Verifications Offers several methods for allowing participants to get authorization to perform certain privileged actions. This module implements several of those methods and also offers a way for installation to implement their custom verification methods.

Community

If you need to have some features that we don't have yet, we recommend that you make a module. This is a Ruby on Rails engine with some APIs specific to Decidim (for registering with the menus, integration with spaces like Participatory Processes or Assemblies, with /admin or /api, etc).

As a base you can use these modules, although check first that the version is compatible with your current Decidim version. Also you should know that until v1.0.0 We're under development and these internal APIs can change. We recommend that you extensively test your module.

Module Version Description
Age Action Authorization 0.9.3 A Decidim based action authorization to check user's age inside actions.
Antivirus 0.15.x-0.16.x Virus scanning validation for uploaded attachments based on ClamAV.
Calendar 0.14.1 Adds a calendar view for all the Meetings, without regarding the Participatory Process or Assembly that they belong.
Crowdfunding 0.14.1 This rails engine implements a Decidim component that allows to the administrators to configure crowfunding campaigns for a participatory space.
DataViz 0.13.1 The Dataviz module adds the PAM data visualizations to any participatory process but it is intended to be used just for the PAM participatory process.
Gravity Forms 0.14.1 A gravity forms component for Decidim.
LDAP 0.9.3 User authentication via LDAP
News 0.14.1 This will add an admin dashboard to manage news posts and front-end views for posts.
Members 0.13.1 Members list and search plugin for Decidim
Personal Number 0.11.0.pre This module allows users to register with a personal number and to log in with it.
Plans 0.15.x-0.16.x Collaborative planning phase for the participatory budgeting projects based on the proposals submitted by people. People can participate on creating the actual plans and collaborate on them before the budgeting voting starts.
Pol.is 0.7.1 Pol.is integration on Decidim
Questions 0.12.2 Questions / Views / Inputs based on decidim-proposals.
Riksdagen 0.11.0.pre A Decidim module to integrate some of the open data produced by the Swedish parliament
Term Customizer 0.16.x Module that allows customizing the translatable terms in the system. The admins can also limit where these customizations apply, e.g. in the whole organization, a specific participatory space or a specific component.
User Export 0.8.3 Allow user export
Votings 0.14.1 An administrator can add one or more votings to a participatory process or assambly

Authorizations Strategies

One specific thing regarding these kind of applications is the authorization/verification logic. Here are some examples:

Other special verifications:

Following our license

If you plan to release your application you'll need to publish it using the same license: GPL Affero 3. We recommend doing that on GitHub before publishing, you can read more on "Being Open Source From Day One is Especially Important for Government Projects". If you have any trouble you can contact us on Gitter.

Example applications

Since Decidim is a ruby gem, you can check out the dependent repositories to see how many applications are on the wild or tests that other developers have made. Here's a partial list with some of the projects that have used Decidim: