Skip to content
No description, website, or topics provided.
Ruby HTML CSS TypeScript JavaScript
Branch: master
Clone or download
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.
.circleci
.github
bin
config
decidim-accountability
decidim-admin
decidim-api
decidim-assemblies
decidim-budgets
decidim-comments
decidim-core
decidim-debates
decidim-dev
decidim-meetings
decidim-pages
decidim-participatory_processes
decidim-proposals
decidim-surveys
decidim-system
decidim-verifications
decidim_app-design
docs
lib
spec
.babelrc
.codeclimate.yml
.csslintrc
.decidim-version
.editorconfig
.eslintignore
.eslintrc.json
.gitattributes
.gitignore
.inch.yml
.mdl_style.rb
.mdlrc
.rubocop.yml
.ruby-version
.simplecov
.yardopts
CHANGELOG.md
CODE_OF_CONDUCT.md
CONTRIBUTING.md
Gemfile
Gemfile.lock
LICENSE-AGPLv3.txt
README.md
Rakefile
codecov.yml
crowdin.yaml
decidim.gemspec
docker-compose.yml
jsconfig.json
logo.svg
package.json
tsconfig.json
tslint.json
webpack.config.js
webpack.d.ts
yarn.lock

README.md

Decidim Logo

The participatory democracy framework.

Democracy never felt so real.

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 codecov Dependency Status Crowdin Inline docs Accessibility issues HTML issues

Project management [See on Waffle.io]

Stories in Discussion Stories in Planned Bugs In Progress In Review


What do you need to do?


Getting started with Decidim

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

How to contribute

As a Translator

Decidim is already translated on multiple languages (English, Spanish, Catalan, Basque, Galician, Italian, Finnish, Dutch, French, Portuguese (and Brazilian Portuguese), Swedish, Russian and Ukrainian). You can help us at Crowdin, the translation service, reviewing these translations or proposing a new language to add to the platform.

As a Developer

In order to develop on decidim, you'll need:

  • Git 2.15+
  • PostgreSQL 9.4+
  • Ruby 2.5.0 (2.3+ should work just fine, but that's the version we test against)
  • NodeJS 9.x.x (with yarn as a package manager)
  • ImageMagick
  • Chrome browser and chromedriver.

The easiest way to work on decidim is to clone decidim's repository and install its dependencies

git clone git@github.com:decidim/decidim.git
cd decidim
bundle install
yarn install

You have several rake tasks available:

  • bundle exec rake development_app: Creates a development app which you can use to run an application with the gems in your path.
  • bundle exec rake test_app: Generates a dummy application to be used for testing.
  • bundle exec rake test_all: Runs the tests of every engine using the dummy application

Browse Decidim

After you create a development app (bundle exec rake development_app):

Optionally, you can log in as: user@example.org | decidim123456

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

Browse Admin Interface

After you create a development app (bundle exec rake development_app):

Officially supported modules

Library Description
Admin Adds an administration dashboard so users can manage their organization and all other entities.
API Exposes a GraphQL API to programatically interact with the Decidim platform via HTTP
Assemblies Permanent participatory 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.
Core The basics of Decidim: users, organizations, etc. This is the only required engine to run Decidim, all the others are optional.
Participatory Processes The main concept of a Decidim installation: participatory processes.
Dev Aids the local development of Decidim's features.
Meeting 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.
Proposals The Proposals module adds one of the main features of Decidim: allows users to contribute to a participatory space by creating proposals.
Accountability Adds an accountability section to any participatory space so users can follow along the state of the accepted proposals.
Surveys Adds the ability for admins to create arbitrary surveys.
System Multitenant Admin to manage multiple organizations in a single installation

Technical tradeoffs

Architecture

This is not your typical Ruby on Rails Vanilla App. We've tried using Consul but we found some problems on reutilization, adaptation, modularization and configuration. You can read more about that on "Propuesta de Cambios de Arquitectura de Consul".

Turbolinks

Decidim doesn't support turbolinks so it isn't included on our generated apps and it's removed for existing Rails applications which install the Decidim engine.

The main reason is we are injecting some scripts into the body for some individual pages and Turbolinks loads the scripts in parallel. For some libraries like leaflet it's very inconvenient because its plugins extend an existing global object.

The support of Turbolinks was dropped in d8c7d9f. If you're interested in bringing turbolinks back, further discussion is welcome.

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:

Decide-Veracruz

You can’t perform that action at this time.