Skip to content

Commit

Permalink
docs: improves the installation instructions
Browse files Browse the repository at this point in the history
Signed-off by: Ishan Masdekar <[email protected]>
  • Loading branch information
imasdekar committed May 27, 2024
1 parent 4a145f9 commit fc3578d
Showing 1 changed file with 16 additions and 6 deletions.
22 changes: 16 additions & 6 deletions plugins/tutor-contrib-library-authoring-mfe/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,30 @@ Installation
Follow these instructions to enable this microfrontend:

* Install `tutor <https://github.com/overhangio/tutor/>`_ and `tutor-mfe <https://github.com/overhangio/tutor-mfe/>`_: ``pip install tutor tutor-mfe``
* Install the library-authoring-mfe plugin: ``pip install git+https://github.com/openedx/openedx-tutor-plugins#subdirectory=plugins/tutor-contrib-library-authoring-mfe``
* Enable this plugin: ``tutor plugins enable library-authoring-mfe``
* Save the tutor config: ``tutor config save``
* Build mfe image: ``tutor images build mfe`` (if you have trouble here you may need to run it with ``--no-cache``)
* Launch tutor: ``tutor local launch``

If you want to run this MFE in
`development mode <https://github.com/overhangio/tutor-mfe/#mfe-development>`_
(to make changes to the code), instead of step 9 above, do this::
* You can do one of the following steps depending on how you want to use this mfe:

If you want to run this MFE in `development mode <https://github.com/overhangio/tutor-mfe/#mfe-development>`_ (to make changes to the code),
do this::

tutor config save --append MOUNTS=./frontend-app-library-authoring

git clone https://github.com/openedx/frontend-app-library-authoring.git

cd frontend-app-library-authoring

nvm use && npm install

tutor dev launch

If you do not want to run this MFE in `development mode <https://github.com/overhangio/tutor-mfe/#mfe-development>`_ do this:

Save the tutor config: ``tutor config save``
* Build mfe image: ``tutor images build mfe`` (if you have trouble here you may need to run it with ``--no-cache``)
* Launch tutor: ``tutor local launch``

Setup
-----
* Ensure you have created a user: https://docs.tutor.overhang.io/local.html#creating-a-new-user-with-staff-and-admin-rights
Expand Down

0 comments on commit fc3578d

Please sign in to comment.