Files
grecia/docs/en/customization/introduction.md

1.7 KiB

Customization

You can modify your own Consul Democracy to have your custom visual style, but first you'll have to create your own fork from.

We've created an specific structure where you can overwrite and customize the application in a way that will let you keep updating it from Consul Democracy's main repository, without having conflicts on code merging or risking loosing your customization changes. We try to make Consul Democracy as vanilla as possible to help other developers onboard the codebase.

Special Folders and Files

In order to customize your Consul Democracy fork, you'll make use of some custom folders on the following paths:

  • app/assets/images/custom/
  • app/assets/javascripts/custom/
  • app/assets/stylesheets/custom/
  • app/components/custom/
  • app/controllers/custom/
  • app/form_builders/custom/
  • app/graphql/custom/
  • app/lib/custom/
  • app/mailers/custom/
  • app/models/custom/
  • app/models/custom/concerns/
  • app/views/custom/
  • config/locales/custom/
  • spec/components/custom/
  • spec/controllers/custom/
  • spec/models/custom/
  • spec/routing/custom/
  • spec/system/custom/

There are also files where you can apply some customizations:

  • app/assets/javascripts/custom.js
  • app/assets/stylesheets/custom.css
  • app/assets/stylesheets/_custom_settings.css
  • app/assets/stylesheets/_consul_custom_overrides.css
  • config/application_custom.rb
  • config/environments/custom/development.rb
  • config/environments/custom/preproduction.rb
  • config/environments/custom/production.rb
  • config/environments/custom/staging.rb
  • config/environments/custom/test.rb
  • Gemfile_custom