Pre-requisites

have an instance of devstack installed and running.

make dev.up.lms

Clone the theme repository

Clone the theme repository in the edx-theme folder created by the devstack installation

git clone <https://github.com/BbrSofiane/edx.custom-theme.git>

https://s3-us-west-2.amazonaws.com/secure.notion-static.com/1451b9c0-d0a4-4f1a-b7e6-41acaebaafb9/edx-theme-folder.gif

Configure your instance

Open a terminal window and navigate to your devstack folder.

make lms-shell
# Inside the lms
vi /edx/etc/lms.yml

Edit the following parameters

COMPREHENSIVE_THEME_DIRS:
- '/edx/app/edx-themes/edx.custom-theme/themes'
...
DEFAULT_SITE_THEME: 'custom-theme'
...
ENABLE_COMPREHENSIVE_THEMING: true

Save and exit lms.yml.

Compile assets

<aside> 💡 Compiling assets is only needed when modifying sass files.

</aside>

Run the following command to compile the assets for the lms.

python manage.py lms compile_sass --settings devstack_docker lms --theme-dirs=/edx/app/edx-themes --themes educate-theme

Wait for the process to finish, it takes more or less time depending on the available resources that your computer has.

Use CTRL+D / CMD+D or exit to exit the lms shell.