darep/customization-engine

Rails customization engine demo

Customization engine

Theme customization engine demo built with Rails.

Understand

The basic idea is to determine per-theme the settings that are customizable. These settings will then be converted to SCSS variables and output just before the theme's actual SCSS, thus resulting in the rendering of SCSS to CSS using the customized variables and enabling customization.

Most of the heavy lifting is done in app/classes/theme_css_renderer.rb, check that file out. It utilises the files of a simple demo theme in app/themes. The actual customization settings are stored in the database via a Customization model.

Usage

Start the Rails server with:

rails s

Open up a rails console session:

rails c

Create an empty, dummy Customization with some settings:

Customization.create(settings: { :'color-brand' => '#0076A0', :'color-text' => '#232326', :'header-title-color' => '#FFFFFF' })

Open http://localhost:3000/demo and go back to console and change the settings and see things change!