frontend-app-learner-dashboard

The Learner Dashboard is a frontend-base application: a library that plugs into the Open edX frontend shell, rather than a standalone micro-frontend bundled with its own webpack build.

This app is the course listing experience for the Open edX Learning Management System. It gives learners a single place to see all of their open enrollments and act on them: resume a course, change a session, manage email settings, unenroll, view related programs, and pursue credit or certificates.

It also hosts a sidebar of widget slots, which operators use for upsell and discovery components.

This app is published to NPM by semantic-release, and its branches follow OEP-10 ADR 0002:

master

Unstable. Every merge publishes a prerelease on the alpha dist-tag. Breaking changes land here with no DEPR process and no warning, so it is not supported in production. All changes, including bug fixes, should target this branch first.

stable

Carries the newest stable major and owns the latest dist-tag. Changes arrive here as backports from master, and no breaking change lands after publication.

n.x and n.m.x

Maintenance branches for majors and minors that stable has moved past. Each owns the dist-tag matching its own name, so consumers select a maintained line by semver range, e.g. "1.x".

stable is cut, and 1.0.0 is the current stable release. Both .releaserc and the Release CI workflow know the whole layout, including the maintenance branch patterns, so a new line starts publishing as soon as it is pushed.

This repository is no longer branched or tagged for Open edX releases in its own right. It participates by published version instead, per OEP-10 ADR 0003.

The micro-frontend this app replaces goes on living on legacy-mfe, which is where any further release/RELEASENAME branches for it are cut, for as long as a supported release still ships it. Teak, Ulmo and Verawood all do.

A running Open edX instance is needed to serve this app's backend APIs. Tutor in development mode is the usual choice, and site.config.dev.tsx already points at its default hostnames.

Unlike a micro-frontend, this app is neither built nor served by tutor-mfe. The dev server below runs on the host. Note that tutor-mfe v22 and later do ship this app as a frontend-base application for deployment, disabled by default; see Frontend apps in its README to enable it.

1. Clone the repo:

   git clone https://github.com/openedx/frontend-app-learner-dashboard.git

2. Use the version of Node specified in the .nvmrc file.

   Using other major versions of Node may work, but is unsupported. This repository includes an .nvmrc file to help set the correct Node version via nvm.

3. Install npm dependencies:

   cd frontend-app-learner-dashboard && npm install

4. Start the dev server:

   npm run dev

The dev server defaults to PORT=1996 PUBLIC_PATH=/learner-dashboard (set in the dev script in package.json) and is available at http://apps.local.openedx.io:1996/learner-dashboard.

Configuration used by the dev server is defined in site.config.dev.tsx at the repo root.

To develop this app and a local checkout of frontend-base in tandem, use the built-in npm workspace support:

mkdir -p packages/frontend-base
sudo mount --bind /path/to/frontend-base packages/frontend-base
npm install
npm run dev:packages

Bind mounts are used instead of symlinks because Node resolves symlinks to their real paths, which breaks hoisted dependency resolution. When you are done, unmount with sudo umount packages/frontend-base.

This app is no longer configured by build-time environment variables. getAppConfig resolves three sources, in order of increasing precedence: the app's bundled defaults, the site's commonAppConfig, and the app's config. The first is the app author's, at build time; the other two are the operator's, the second applying to every app on the site and the third to this app alone. In edx-platform they arrive as MFE_CONFIG and MFE_CONFIG_OVERRIDES['learner-dashboard'] respectively.

The full list of keys and their defaults is the config block in src/app.ts:

This app offers slots for operators to customize its pages. See src/slots/ for the current list and per-slot READMEs with usage examples.

The layout follows the standard frontend-base app layout:

• src/app.ts - the app definition imported by site.config.*.tsx.
• src/constants.ts - the app's appId and route role identifiers.
• src/index.ts - the package's public exports (this is a library).
• src/routes.jsx - the app's react-router routes.
• src/Main.jsx - the root component for the app's routes.
• src/providers.ts - the context providers the app wraps the site in.
• src/slots.tsx - slot operations this app performs on other apps' slots, such as the header.
• src/slots/ - the slots this app offers to consumers.
• src/widgets/ - components this app contributes to slots, including its header.
• src/style.scss - app-scoped runtime styles.

Everything else under src/ is a feature or shared-concern directory: containers/ for the page's composed pieces, components/ for the reusable ones, data/ for API access and React Query hooks, and hooks/, tracking/ and utils/ for the shared remainder.

For more, see the frontend-base migration how-to.

Library build

npm run build compiles the library into dist/ via tsc and tsc-alias, and copies the SCSS and asset files across. This is what gets published and consumed by sites.

CI build

npm run build:ci runs openedx build against site.config.ci.tsx so webpack traverses the full app graph. This catches issues, such as broken lazy-loaded imports, that tsc and Jest would not surface.

Please refer to the frontend-base i18n howto for documentation on internationalization.

If you're having trouble, we have discussion forums at https://discuss.openedx.org where you can connect with others in the community.

Our real-time conversations are on Slack. You can request a Slack invitation, then join our community Slack workspace. Because this is a frontend repository, the best place to discuss it would be in the #wg-frontend channel.

For anything non-trivial, the best path is to open an issue in this repository with as many details about the issue you are facing as you can provide.

https://github.com/openedx/frontend-app-learner-dashboard/issues

For more information about these options, see the Getting Help page.

The code in this repository is licensed under the AGPLv3 unless otherwise noted.

Please see LICENSE for details.

Contributions are very welcome. Please read How To Contribute for details.

This project is currently accepting all types of contributions, bug fixes and security fixes.

All community members are expected to follow the Open edX Code of Conduct.

The assigned maintainers for this component and other project details may be found in Backstage. Backstage pulls this data from the catalog-info.yaml file in this repo.

Please do not report security issues in public, and email security@openedx.org instead.