Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Make a change in your locally checked out plugin repo, the platform should reload with your changes.

Working with MFEs

WIPMFEs can be added to your development environment using the https://github.com/overhangio/tutor-mfe plugin. You can read more about Tutor plugins here: https://docs.tutor.overhang.io/plugins/intro.html .

Enable tutor-mfe

Follow the instruction at https://github.com/overhangio/tutor-mfe to install and enable the tutor-mfe plugin. By default this plugin will allow you to run the account, gradebook, profile and learning MFEs.

Running your local branch

  1. Checkout the frontend repository

  2. On you local machine install node requirements using an npm version suitable for that codebase.

  3. Run tutor dev with --mount

    Code Block
    tutor dev start learning \
          -m learning:$HOME/workspace/frontend-app-learning:/openedx/app

What about other frontend projects?

Most MFE projects share the same environment variables and build tasks so the tutor-mfe plugin should be able to handle other projects if given some additional configuration. At minimum you will need the project name, port, and git url. Some projects may require additional environment variables.

open your local config

Code Block
languagebash
vim "$(tutor config printroot)"/config.yml

add your new MFE (course-authoring as an example)

Code Block
languageyaml
MFE_AUTHORING_MFE_APP:
  name: authoring
  port: 2001
  repository: https://github.com/edx/frontend-app-course-authoring
  env:
    development:
      APP_SPECIFIC_URL: http://blah.co

*note the MFE_ prefix, this is important for your settings to get picked up by tutor-mfe

Quickstart edx-enterprise Development in Tutor

...