This is the custom Extension micro-frontend for the Webuddhist Academy Open edX site.
The following Tutor plugin code can be used to install and configure this MFE in a Tutor environment.
The Tutor platform is a prerequisite for developing an MFE. Utilize relevant tutor-mfe documentation to guide you through the process of MFE development within the Tutor environment.
- Clone the repo:
git clone https://github.com/Webuddhist-tech/frontend-app-extension.git
- Use the version of node in the .nvmrc file.
The current version of the micro-frontend build scripts supports the node version in .nvmrc. Using other major versions of node may work, but this is unsupported. For convenience, this repository includes an .nvmrc file to help in setting the correct node version via nvm.
- Install npm dependencies:
cd frontend-app-extension && npm ci
- Mount the frontend-app-extension MFE in Tutor:
tutor mounts add <your-tutor-project-dir>/frontend-app-extension
- Build the Docker image:
tutor images build extension-dev
- Launch the development server with Tutor:
tutor dev start extension
The dev server is running at http://apps.local.openedx.io:2003/extension/.
If you start Tutor with tutor dev start extension
that should give you everything you need as a companion to this frontend.
Please see refer to the frontend-platform i18n howto for documentation on internationalization.
The code in this repository is licensed under the AGPLv3. See LICENSE.