|
1 | 1 | # frontend-app-program-console
|
| 2 | + |
| 3 | +# Purpose |
| 4 | + |
2 | 5 | A micro-frontend for administering edX program membership through the Registrar API.
|
3 | 6 |
|
4 | 7 | Uses the [Registrar Service](https://github.com/openedx/registrar/) as a data/AuthZ backend and [LMS](https://github.com/openedx/edx-platform) as an AuthN backend.
|
| 8 | + |
| 9 | +# Getting Started |
| 10 | + |
| 11 | +## Prerequisites |
| 12 | + |
| 13 | +The `devstack`_ is currently recommended as a development environment for your |
| 14 | +new MFE. If you start it with ``make dev.up.lms`` that should give you |
| 15 | +everything you need as a companion to this frontend. |
| 16 | + |
| 17 | +Note that it is also possible to use `Tutor`_ to develop an MFE. You can refer |
| 18 | +to the `relevant tutor-mfe documentation`_ to get started using it. |
| 19 | + |
| 20 | +.. _Devstack: https://github.com/openedx/devstack |
| 21 | + |
| 22 | +.. _Tutor: https://github.com/overhangio/tutor |
| 23 | + |
| 24 | +.. _relevant tutor-mfe documentation: https://github.com/overhangio/tutor-mfe#mfe-development |
| 25 | + |
| 26 | +## Cloning and Startup |
| 27 | + |
| 28 | +1. Clone your new repo: |
| 29 | + |
| 30 | + ``git clone https://github.com/openedx/frontend-app-program-console.git`` |
| 31 | + |
| 32 | +2. Install npm dependencies: |
| 33 | + |
| 34 | + ``cd frontend-app-program-console && npm install`` |
| 35 | + |
| 36 | +3. Start the dev server: |
| 37 | + |
| 38 | + ``npm start`` |
| 39 | + |
| 40 | +The dev server is running at `http://localhost:1976 <http://localhost:1976>`_. |
| 41 | + |
| 42 | + |
| 43 | +## Contributing |
| 44 | + |
| 45 | +Contributions are very welcome. Please read `How To Contribute`_ for details. |
| 46 | + |
| 47 | +.. _How To Contribute: https://openedx.org/r/how-to-contribute |
| 48 | + |
| 49 | +This project is currently accepting all types of contributions, bug fixes, |
| 50 | +security fixes, maintenance work, or new features. However, please make sure |
| 51 | +to have a discussion about your new feature idea with the maintainers prior to |
| 52 | +beginning development to maximize the chances of your change being accepted. |
| 53 | +You can start a conversation by creating a new issue on this repo summarizing |
| 54 | +your idea. |
| 55 | + |
| 56 | +## Getting Help |
| 57 | + |
| 58 | +If you're having trouble, we have discussion forums at |
| 59 | +https://discuss.openedx.org where you can connect with others in the community. |
| 60 | + |
| 61 | +Our real-time conversations are on Slack. You can request a `Slack |
| 62 | +invitation`_, then join our `community Slack workspace`_. Because this is a |
| 63 | +frontend repository, the best place to discuss it would be in the `#wg-frontend |
| 64 | +channel`_. |
| 65 | + |
| 66 | +For anything non-trivial, the best path is to open an issue in this repository |
| 67 | +with as many details about the issue you are facing as you can provide. |
| 68 | + |
| 69 | +https://github.com/openedx/frontend-app-program-console/issues |
| 70 | + |
| 71 | +For more information about these options, see the `Getting Help`_ page. |
| 72 | + |
| 73 | +.. _Slack invitation: https://openedx.org/slack |
| 74 | +.. _community Slack workspace: https://openedx.slack.com/ |
| 75 | +.. _#wg-frontend channel: https://openedx.slack.com/archives/C04BM6YC7A6 |
| 76 | +.. _Getting Help: https://openedx.org/community/connect |
| 77 | + |
| 78 | +## License |
| 79 | + |
| 80 | +The code in this repository is licensed under the AGPLv3 unless otherwise |
| 81 | +noted. |
| 82 | + |
| 83 | +## The Open edX Code of Conduct |
| 84 | + |
| 85 | +All community members are expected to follow the `Open edX Code of Conduct`_. |
| 86 | + |
| 87 | +.. _Open edX Code of Conduct: https://openedx.org/code-of-conduct/ |
| 88 | + |
| 89 | +## Reporting Security Issues |
| 90 | + |
| 91 | +Please do not report security issues in public. Please email [email protected]. |
| 92 | + |
0 commit comments