edX Credentials Themes

This repository holds themes for the edX Credentials Service.

Building

Build the assets by running make build. Compiled assets should be committed to the repository so that they are accessible by the Credentials Service when the package is installed.

i18n

Run make base_requirements to install dependencies necessary for running i18n commands. Note: this will install Django and is best done from within a Python virtualenv.

To mark strings in templates/partials for translation, simply wrap them in one of Django's built-in translation functions. See https://docs.Djangoproject.com/en/1.11/topics/i18n/translation/#internationalization-in-template-code for more details.

Extract strings that have been marked for translation by running make extract_translations. This command will produce a gettext .po file, ./conf/locale/en/LC_MESSAGES/django.po, which may be uploaded to Transifex (or another translation provider) where the strings can be translated.

Compile translated strings by running make compile_translations. This will produce a .mo file for each .po in the repo. The .mo files are read by Django and are used to provide translations in the running application.

Developing in devstack

In order to develop in devstack, make sure your devstack is running, then:

1. Switch your devstack to the edX theme
2. Clone this repo into <devstack_folder>/src/
3. cd <devstack_folder>/devstack/
4. make dev.shell.credentials
5. make requirements
6. pip install -e /edx/src/credentials-themes - this will override the version that was installed in the previous step
7. make static