The console aims to centralize platform-level settings and administrative tasks—including authorization (AuthZ) and, eventually, other key configurations—into a single, extensible UI. It reduces platform fragmentation and improves administrator efficiency.
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
alphadist-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
latestdist-tag. Changes arrive here as backports frommaster, and no breaking change lands after publication. n.xandn.m.x- Maintenance branches for majors and minors that
stablehas 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 has not been cut yet: until this app is first ready for
production use, master and its alphas are all there is. Both
.releaserc and the Release CI workflow already 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. Ulmo and
Verawood both 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. Install dependencies with npm ci (using the Node
version in .nvmrc), then start the dev server on the host with
npm run dev; it serves the app at
http://apps.local.openedx.io:2025/admin-console.
This repository works with openedx-authz
This frontend app can be customized using the <Slot /> component from frontend-base. See the slot naming and lifecycle ADR for the slot API and conventions.
The parts of this frontend app that can be customized in that manner are documented here.
- Technical Approach: Console MVP (AuthZ-Scoped, Ulmo Release).
- Administrative Console Long-Term Technical Approach.
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-admin-console/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, security fixes, maintenance work, or new features. However, please make sure to have a discussion about your new feature idea with the maintainers prior to beginning development to maximize the chances of your change being accepted. You can start a conversation by creating a new issue on this repo summarizing your idea.
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. Email security@openedx.org instead.