Manage Open edX projects¶
Derex simplifies running edX: it takes care of starting the needed services (mysql, mongodb, rabbitmq etc) and introduces the concept of edX _projects_.
A project is a directory that defines what an edX instance should look like. It can specify additional requirements, custom themes and plugins.
`derex.runner` uses docker compose (it’s bundled, you don’t have to
install it separately) to orchestrate the many necessary pieces.
Make sure you have python 3.6 or later and docker 19.03.5 or later installed.
A virtualenv is also recommended. For derex we use direnv. Its main purpose is to define directory-specific
environment variables, but it can also automatically activate a virtualenv when
`cd` into a directory. We include a
`.envrc` file that will instruct
`direnv` to create and activate a local python3 virtualenv.
We recommend to install it to try
out the following instructions. Alternatively you can replace
with your virtualenv activation command.
Run the following commands:
git clone https://github.com/Abstract-Tech/derex.runner.git cd derex.runner direnv allow pip install -r requirements.txt -e . cd tests/fixtures/minimal/ ddc-services up -d # Start mysql, mongodb, rabbitmq and admin tools derex reset-mailslurper # Prime the mailslurper mysql database derex reset-mysql # Prime the mysql database ddc-project up -d # Start LMS/CMS daemons and workers derex compile-theme # Compile theme sass files
Then head to one of the started services:
Flower(monitor celery workers)
Mailslurper(debug emails sent by the platform)
Adminer(mysql administration tool)
Portainer(docker administration tool)
You can login to the CMS and LMS using one of these users (the password is
email@example.comRepresents a student user.
firstname.lastname@example.orgRepresents a member of the teaching staff.
email@example.comRepresents an administrator of Open edX. This user has full permissions inside the platform.