Skip to content

Open edX micro-frontend application for viewing learner records

License

Notifications You must be signed in to change notification settings

EDUlib/frontend-app-learner-record

 
 

Repository files navigation

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.

Installation

  1. Clone the repository this repository

  2. Enter the directory

  3. Install dependencies

  4. Start the Learner Record MFE

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

Environment Variables/Setup Notes

This MFE will use a REST API from the Credentials IDA located at credentials/apps/records/rest_api

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

About

Open edX micro-frontend application for viewing learner records

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 76.2%
  • Makefile 14.6%
  • Shell 3.5%
  • HTML 3.1%
  • SCSS 2.6%