christianlight/tutor
6
0
Fork 0
mirror of https://github.com/ChristianLight/tutor.git synced 2024-12-13 06:37:46 +00:00
Code Issues Releases Activity

Improve documentation on running a local edx-platform

Browse Source 
Close #173.
This commit is contained in:
Régis Behmo 2019-02-17 14:01:43 +01:00
parent 3e59b530f8
commit b643a87190
1 changed files with 26 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
docs/dev.rst
View File

@ -21,8 +21,8 @@ Open a bash shell
tutor dev shell lms
tutor dev shell cms
Debug edx-platform
------------------
Point to a local edx-platform
-----------------------------
If you have one, you can point to a local version of `edx-platform <https://github.com/edx/edx-platform/>`_ on your host machine. To do so, pass a ``-P/--edx-platform-path`` option to the commands. For instance::
@ -32,9 +32,12 @@ If you don't want to rewrite this option every time, you can instead define the
export TUTOR_EDX_PLATFORM_PATH=/path/to/edx-platform
All development commands will then automatically mount your local repo. For instance, you can add a ``import pdb; pdb.set_trace()`` breakpoint anywhere in your code and run::
All development commands will then automatically mount your local repo.
tutor dev runserver lms --edx-platform-path=/path/to/edx-platform
**Note:** containers are built on the Hawthorn release. If you are working on a different version of Open edX, you will have to rebuild the ``openedx`` docker images with the version. See the ":ref:`fork edx-platform <edx_platform_fork>`.
Set up settings
~~~~~~~~~~~~~~~
With a customised edx-platform repo, you must be careful to have settings that are compatible with the docker environment. You are encouraged to copy the ``tutor.development`` settings files to our own repo::
@ -43,7 +46,21 @@ With a customised edx-platform repo, you must be careful to have settings that a
You can then run your platform with the ``tutor.development`` settings. See :ref:`the custom settings section <custom_edx_platform_settings>` for settings that are named differently.
**Note:** containers are built on the Hawthorn release. If you are working on a different version of Open edX, you will have to rebuild the ``openedx`` docker images with the version. See the ":ref:`fork edx-platform <edx_platform_fork>`.
Prepare the edx-platform repo
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
In order to run a fork of edx-platform, dependencies need to be properly installed and assets compiled in that repo. To do so, run::
tutor dev run --edx-platform-path=/path/to/edx-platform lms npm install
tutor dev run --edx-platform-path=/path/to/edx-platform lms python setup.py
tutor dev run --edx-platform-path=/path/to/edx-platform lms openedx-assets build
Debug edx-platform
~~~~~~~~~~~~~~~~~~
To debug a local edx-platform repository, add a ``import pdb; pdb.set_trace()`` breakpoint anywhere in your code and run::
tutor dev runserver lms --edx-platform-path=/path/to/edx-platform
Customised themes
-----------------
@ -73,6 +90,10 @@ Assets building and collecting is made more difficult by the fact that developme
openedx-assets build
Alternatively, run from the host::
tutor dev run lms openedx-assets build
This command will take quite some time to run. You can speed up this process by running only part of the full build. Run ``openedx-assets -h`` for more information.
Running python commands