/frontend-app-learner-record

Open edX micro-frontend application for viewing learner records

Primary LanguageJavaScriptGNU Affero General Public License v3.0AGPL-3.0

Build Status Codecov license

frontend-app-learner-record

Please tag @edx/aperture-eng on any PRs or issues. Thanks.

Introduction

This is the Learner Record micro-frontend, currently under development by edX.

The Learner Record provides information about the enrolled programs for a user.

Local Development

  1. Clone the repository this repository

  2. Enter the directory

    cd frontend-app-learner-record

  3. Clean Install dependencies

    npm ci

  4. Start the Learner Record MFE

    npm start

The page is currently hosted on http://localhost:1990/

Environment Variables/Setup Notes

Currently, this MFE is not intergrated into the devstack, and must be run locally. This MFE requires credentials to be running, and will use a REST API from the Credentials IDA located at credentials/apps/records/rest_api.

Credentials uses 2 enviroment variables to link to this MFE:

  • USE_LEARNER_RECORD_MFE -- Toggles the navigation in credentials to redirect to this MFE
  • LEARNER_RECORD_MFE_RECORDS_PAGE_URL -- The URL for the base URL of this MFE

More details for these flags can be found in the base configuration of credentials: credentials/settings/base This MFE has 2 flags of its own:

  • SUPPORT_URL_LEARNER_RECORDS -- A link to a help/support center for learners who run into problems whilst trying to share their records
  • USE_LR_MFE -- A toggle that when on, uses the MFE to host shared records instead of the the old UI inside of credentials

Project Structure

The source for this project is organized into nested submodules according to the ADR Feature-based Application Organization.

Build Process Notes

Production Build

The production build is created with npm run build.

Internationalization

Please see edx/frontend-platform's i18n module for documentation on internationalization. The documentation explains how to use it, and the How To has more detail.

Known Issues

Development Roadmap

The following is a list of current short-term development targets, in (rough) descending order of priority:

Learner Record MFE Epic: `https://openedx.atlassian.net/browse/MICROBA-1296`_

  • Set up automated deployment for MFE
  • Implement Learner Record MFE to mirror the currently existing Learner Record page
  • Add user masquerading
  • Update Profile MFE to redirect to new Learner Record MFE
  • Set up automated dependency updates