The participatory democracy framework. > Democracy never felt so real. Decidim is a participatory democracy framework written on Ruby on Rails originally developed for the Barcelona City government online and offline participation website. Installing this libraries you'll get a generator and gems to help you develop web applications like the ones found on [example applications](#example-applications) or like [our demo application](http://staging.decidim.codegram.com). --- [](https://rubygems.org/gems/decidim) [](https://rubygems.org/gems/decidim) [](https://github.com/decidim/decidim/graphs/contributors) [](http://rubydoc.info/github/decidim/decidim/master) [](https://gitter.im/decidim/decidim) ### Code quality [](https://circleci.com/gh/decidim/decidim) [](https://codeclimate.com/github/decidim/decidim/trends) [](https://codecov.io/gh/decidim/decidim) [](https://gemnasium.com/github.com/decidim/decidim) [](https://crowdin.com/project/decidim) [](http://inch-ci.org/github/decidim/decidim) [](https://rocketvalidator.com/badges/link?url=http://staging.decidim.codegram.com/&report=a11y) [](https://rocketvalidator.com/badges/link?url=http://staging.decidim.codegram.com/&report=html) ### Project management [[See on Waffle.io]](https://waffle.io/decidim/decidim) [](https://github.com/decidim/decidim/issues?q=is%3Aopen+is%3Aissue+label%3Adiscussion) [](https://github.com/decidim/decidim/issues?q=is%3Aopen+is%3Aissue+label%3Aplanned) [](https://github.com/decidim/decidim/issues?q=is%3Aopen+is%3Aissue+label%3Abug) [](https://github.com/decidim/decidim/issues?q=is%3Aopen+is%3Aissue+label%3Ain-progress) [](https://github.com/decidim/decidim/issues?q=is%3Aopen+is%3Aissue+label%3Ain-review) --- ## What do you need to do? - [Get started with Decidim](#getting-started-with-decidim) - [Contribute to the project](#how-to-contribute) - [Decidim components](#components) - [How to test Decidim engines](#testing) - [Create & browse development app](#browse-decidim) - [Check current components](#components) - [Technical tradeoffs](#technical-tradeoffs) --- ## Getting started with Decidim We've set up a guide on how to install, set up and upgrade Decidim. See the [Getting started guide](https://github.com/decidim/decidim/blob/master/docs/getting_started.md). ## How to contribute ### As a Translator Decidim is already translated on multiple languages (English, Spanish, Catalan, Basque, Italian, Finnish, Dutch and French). You can help us at [Crowdin, the translation service](https://crowdin.com/project/decidim), reviewing this translations or proposing a new language to add to the platform. ### As a Developer In order to develop on decidim, you'll need: * **PostgreSQL** 9.4+ * **Ruby** 2.4.1 * **NodeJS** with **yarn** (JavaScript dependency manager, can be installed with `npm install yarn`) * **ImageMagick** * **PhantomJS** The easiest way to work on decidim is to clone decidim's repository and install its dependencies ```bash $ git clone git@github.com:decidim/decidim.git $ cd decidim $ bundle install $ yarn install ``` You have several rake tasks available for you: * `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_all`: Generates a test app for every engine and runs their tests. #### Browse Decidim After you create a development app (`bundle exec rake development_app`): - `cd development_app` - `bundle exec rails s` - Go to 'http://localhost:3000' 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`): - `cd development_app` - `bundle exec rails s` - Go to 'http://localhost:3000/admin' - Login data: admin@example.org | decidim123456 ## Officially supported libraries | Library | Description | | ------------- |-------------| | [Admin](https://github.com/decidim/decidim/tree/master/decidim-admin) | This library adds an administration dashboard so users can manage their organization, participatory processes and all other entities. | | [API](https://github.com/decidim/decidim/tree/master/decidim-api) | This library exposes a GraphQL API to programatically interact with the Decidim platform via HTTP | | [Budgets](https://github.com/decidim/decidim/tree/master/decidim-budgets) | Adds a participatory budgets system to any participatory process. | | [Comments](https://github.com/decidim/decidim/tree/master/decidim-comments) | The Comments module adds the ability to include comments to any resource which can be commentable by users. | | [Core](https://github.com/decidim/decidim/tree/master/decidim-core) | The basics of Decidim: users, participatory processes, etc. This is the only required engine to run Decidim, all the others are optional. | | [Dev](https://github.com/decidim/decidim/tree/master/decidim-dev) | This gem aids the local development of Decidim's features. | | [Meeting](https://github.com/decidim/decidim/tree/master/decidim-meetings) | The Meeting module adds meeting to any participatory process. It adds a CRUD engine to the admin and public view scoped inside the participatory process. | | [Pages](https://github.com/decidim/decidim/tree/master/decidim-pages) | The Pages module adds static page capabilities to any participatory process. It basically provides an interface to include arbitrary HTML content to any step. | | [Proposals](https://github.com/decidim/decidim/tree/master/decidim-proposals) | The Proposals module adds one of the main features of Decidim: allows users to contribute to a participatory process by creating proposals. | | [Results](https://github.com/decidim/decidim/tree/master/decidim-results) | Adds a results section to any participatory process so users can follow along the state of the accepted proposals. | | [Surveys](https://github.com/decidim/decidim/tree/master/decidim-surveys) | Adds the ability for admins to create arbitrary surveys. | | [System](https://github.com/decidim/decidim/tree/master/decidim-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 that using [Consul](http://decide.es) but we've found some problems on reutilization, adaptation, modularization and configuration. You can read more about that on "[Propuesta de Cambios de Arquitectura de Consul](https://www.gitbook.com/book/alabs/propuesta-de-cambios-en-la-arquitectura-de-consul/details)". ### 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 for this 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](http://leafletjs.com/) it's very inconvenient because its plugins extend an existing global object. The support of Turbolinks was dropped in [d8c7d9f](https://github.com/decidim/decidim/commit/d8c7d9f63e4d75307e8f7a0360bef977fab209b6). 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](http://producingoss.com/en/governments-and-open-source.html#starting-open-for-govs)". If you have any trouble doing that you can contact us on [Gitter](https://gitter.im/decidim/decidim). ## Example applications Since Decidim is a ruby gem, you can check out the [dependent repositories](https://github.com/decidim/decidim/network/dependents?type=application) 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: * [Demo](http://staging.decidim.codegram.com) * [Decidim Barcelona](https://decidim.barcelona) - [View code](https://github.com/AjuntamentdeBarcelona/decidim-barcelona) * [L'H ON Participa](https://www.lhon-participa.cat) - [View code](https://github.com/HospitaletDeLlobregat/decidim-hospitalet) * [Decidim Terrassa](https://participa.terrassa.cat) - [View code](https://github.com/AjuntamentDeTerrassa/decidim-terrassa) * [Decidim Sabadell](https://decidim.sabadell.cat) - [View code](https://github.com/AjuntamentDeSabadell/decidim-sabadell) * [Decidim Gavà](https://participa.gavaciutat.cat) - [View code](https://github.com/AjuntamentDeGava/decidim-gava) * [Decidim Sant Cugat](https://decidim.santcugat.cat/) - [View code](https://github.com/AjuntamentdeSantCugat/decidim-sant_cugat) * [Vilanova Participa](http://participa.vilanova.cat) - [View code](https://github.com/vilanovailageltru/decidim-vilanova) * [Erabaki Pamplona](https://erabaki.pamplona.es) - [View code](https://github.com/ErabakiPamplona/erabaki) * [Decidim Mataró](https://www.decidimmataro.cat) - [View code](https://github.com/AjuntamentDeMataro/decidim-mataro)