This file is a template for README.md of Octree instances.

Decidim - Octree Participatory democracy on a robust and open source solution

Octree | Contact Us | Our Blog (FR)

Decidim | Decidim Docs | Participatory Governance (meta decidim)

Decidim Community (Matrix+Element.io)



Want to hack Decidim theme? This repo implements a resilient design system on Decidim, allowing you to bootstrap your new theme. This repository is a Decidim module for Decidim without redesign.

This module is installed by default on all our voca instances.

Installation

Add to your Gemfile: 

gem "deface", ">= 1.5"
gem "decidim-theme", git: "https://github.com/decidim/decidim-module-theme"

Import the theme settings:

// file: app/packs/stylesheets/decidim/_decidim-settings.scss
@import "stylesheets/decidim/theme/theme_settings"

Add the theme file to override the rest:

// file: app/packs/stylesheets/decidim/decidim_application.scss
@import "stylesheets/decidim/theme/theme"

Add preload tags on head for fonts, to have less FOUT:

<!-- file: app/views/layouts/decidim/_head_extra.html.erb -->
<%= preload_link_tag(asset_pack_path("media/images/Inter-Bold.woff2")) %>
<%= preload_link_tag(asset_pack_path("media/images/Inter-Regular.woff2")) %>
<%= preload_link_tag(asset_pack_path("media/images/Inter-SemiBold.woff2")) %>

Compatibility

This module is tested with Decidim V.0.26 only. 0.27 is comming with ruby-3 support soon.

Develop localy

docker-compose up -d

# Install (first time only)
docker exec -it decidim-app bundle exec rails db:migrate
docker exec -it decidim-app bundle exec rails db:seed

# Run webpack-dev-server
docker exec -it decidim-app bin/webpack-dev-server

# Run rails server
docker exec -it decidim-app bundle exec rails s -b 0.0.0.0

Wait webpack-dev-server has compiled, and go to localhost:3000.

Core Customizations

In a perfect world, we would need no core customization. We try hard to keep track on our changes and propose them to the core of Decidim. Our goal is always to come back to a mainstream code. We use the Deface gem to mainly:

  • Change button classes to have consistent buttons variants.
  • Add class to wrapper in many, many files











Decidim Installation by Octree