How To Get Ready for Frontend Development#

This how-to will help prepare your local system to start developing on an MFE that is part of the front-end of the Open edX Platform.

Assumptions#

  • You know how to use Git

  • You have the Open edX Legacy Devstack setup and the LMS is running.

  • You are running Node 16.x.x

Steps#

Note

Most MFEs will follow the steps defined here but we always recommend reviewing the README of an MFE as it will have more detailed instructions that are specific to the project.

  1. Clone the repository locally.

    git clone <git_url>
    
  2. Install the Node dependencies

    cd <repo_dir> && npm clean-install
    
  3. Start the dev server

    npm start