A micro-frontend for administering edX program membership through the Registrar API.
Uses the Registrar Service as a data/AuthZ backend and LMS as an AuthN backend.
The devstack_ is currently recommended as a development environment for your
new MFE. If you start it with make dev.up.lms that should give you
everything you need as a companion to this frontend.
Note that it is also possible to use Tutor_ to develop an MFE. You can refer
to the relevant tutor-mfe documentation_ to get started using it.
.. _Devstack: https://github.com/openedx/devstack
.. _Tutor: https://github.com/overhangio/tutor
.. _relevant tutor-mfe documentation: https://github.com/overhangio/tutor-mfe#mfe-development
- Clone your new repo:
git clone https://github.com/openedx/frontend-app-program-console.git
- Install npm dependencies:
cd frontend-app-program-console && npm install
- Start the dev server:
npm start
The dev server is running at http://localhost:1976 <http://localhost:1976>_.
Contributions are very welcome. Please read How To Contribute_ for details.
.. _How To Contribute: https://openedx.org/r/how-to-contribute
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.
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-program-console/issues
For more information about these options, see the Getting Help_ page.
.. _Slack invitation: https://openedx.org/slack .. _community Slack workspace: https://openedx.slack.com/ .. _#wg-frontend channel: https://openedx.slack.com/archives/C04BM6YC7A6 .. _Getting Help: https://openedx.org/community/connect
The code in this repository is licensed under the AGPLv3 unless otherwise noted.
All community members are expected to follow the Open edX Code of Conduct_.
.. _Open edX Code of Conduct: https://openedx.org/code-of-conduct/
Please do not report security issues in public. Please email [email protected].