Skip to content

Setting up an OpenCraft Sandbox

The OpenCraft sandbox is a slightly customised version of the Open edX platform with some theming modifications. These theming modifications require a few modifications to the grove config.

First, you need to use the release/teak version of the comprehensive theme in grove.yml since that is the last version that supports comprehensive theming. To customise the logos, you will need to add the following to the theme in grove.yml:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
COMPREHENSIVE_THEME_VERSION: release/teak
SIMPLE_THEME_STATIC_FILES_URLS:
    - dest: lms/static/images/logo.png
    url: https://raw.githubusercontent.com/open-craft/brand-openedx/refs/heads/sandbox/logo.png
    - dest: lms/static/images/logo-trademark.png
    url: https://raw.githubusercontent.com/open-craft/brand-openedx/refs/heads/sandbox/logo-trademark.png
    - dest: lms/static/images/logo-white.png
    url: https://raw.githubusercontent.com/open-craft/brand-openedx/refs/heads/sandbox/logo-white.png
    - dest: lms/static/images/favicon.ico
    url: https://raw.githubusercontent.com/open-craft/brand-openedx/refs/heads/sandbox/favicon.ico

The tutor config likewise needs a few modifications. You will need to use add sandbox and grove-simple-theme to the list of plugins. If you're using Teak then also add teak_design_tokens.

1
2
3
4
PLUGINS:
  - sandbox
  - teak_design_tokens
  - grove-simple-theme

NOTE: While grove-simple-theme is a part of the tutor-contrib-grove package (in v20+) the other two are local plugins that should be in the plugins directory of grove-production-digitalocean.

The sandbox plugin will install the latest version of the header (needed for Teak) and configure plugin slots to modify the header and footer. The teak_design_tokens plugin will switch all MFEs to the design token branch.

The grove-simple-theme enables theming using the new simple theme based on design tokens. It needs to be configured to use the sandbox branch of open-craft/brand-openedx instead of the default simple theme repo:

1
2
GROVE_SIMPLE_THEME_BRANCH: sandbox
GROVE_SIMPLE_THEME_REPO: https://github.com/open-craft/brand-openedx.git