This repository includes Opale Redmine Theme as a Git submodule.

To initialize and fetch Opale after cloning, run:

git submodule update --init --recursive

Or, do everything in one step when cloning:

git clone --recurse-submodules https://github.com/gagnieray/custom-opale-builder.git my_custom_opale

This ensures Opale is downloaded and checked out at the correct commit.

If you want to customize Opale Redmine Theme to your needs, first, make sure that you have installed Node.js and npm is available in your terminal.

All the variables defined in src/opale/src/sass/_variables.scss with the !default flag can be overridden in src/_custom-variables.scss.

Example:

@use 'variables' with (
  $sidebar-position: right,
  $brand-primary: #614ba6
);

Then, run the script from the project root directory:

./build

The result will be available in the dist/ folder created during the process, ready to be installed in your Redmine's themes folder.

You can add a custom favicon simply by adding it in the src/favicon/ folder. The file must be named favicon.ico.

If you don't need a custom favicon, delete the src/favicon/ folder.

You can add a logo to be displayed in the pages' header.

In order to do that :

1. Add your logo in the src/images/logo/ folder. The file must be named logo.png.

2. Define the required variables in src/_custom-variables.scss.

   @use 'variables' with (
     $use-logo: true,
     $logo-image-width: 150px,
     $logo-image-height: 60px,
     $header-padding-vertical: 25px, // Only required if $logo-image-height > 40px
     // ...
   );

If you don’t need a logo, simply delete the src/images/ folder.

Usage: ./build [OPTIONS] <COMMAND>

Options:
  -b BASE     Opale base branch to use (default: master)
  -n NAME     Package name (default: opale_customized)
  -p yes/no   Include plugins stylesheets (default: no)
  -v VERSION  Package version (optional)
  -h          Display this help message

Commands:
  package     Build and package the theme into a .tar.gz archive
  help        Display this help message

Examples:
  ./build -b redmine-5.x -p yes
  ./build -n my_theme -v 1.0.0 package
  ./build -b redmine-6.x -n custom_theme -v 2.1.0 package

Notes:
  - Options must be placed before the command
  - Version is optional; if provided, it's appended to the package name
  - The script must be run from the project root directory

Custom Opale Redmine Theme Builder is licensed under the GNU Affero General Public License v3.0 or later, the text of which can be found in LICENSE.