diff --git a/README.rst b/README.rst index 7fa10bd45..c6f81e027 100644 --- a/README.rst +++ b/README.rst @@ -1,10 +1,13 @@ +#################### +frontend-app-account +#################### + |ci-badge| |Codecov| |npm_version| |npm_downloads| |license| |semantic-release| -frontend-app-account -==================== -Introduction ------------- +******** +Purpose +******** This is a micro-frontend application responsible for the display and updating of a user's account information. @@ -18,8 +21,28 @@ In this MFE: Private user settings UIs. Public facing profile is in a `separate - IDV (Identity Verification) +*************** +Getting Started +*************** + +Prerequisites +============= + +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 + Installation ------------- +============ This MFE is bundled with `Devstack `_, see the `Getting Started `_ section for setup instructions. @@ -41,7 +64,7 @@ This MFE is bundled with `Devstack `_, see .. image:: ./docs/images/localhost_preview.png Environment Variables/Setup Notes ---------------------------------- +================================= This MFE is configured via environment variables supplied at build time. All micro-frontends have a shared set of required environment variables, as documented in the Open edX Developer Guide under `Required Environment Variables `__. @@ -71,7 +94,7 @@ Enable the account deletion option, defaults to true. To disable account deletion set ``ENABLE_ACCOUNT_DELETION`` to ``'false'`` (string), otherwise it will default to true. edX-specific Environment Variables -********************************** +================================== Furthermore, there are several edX-specific environment variables that enable integrations with closed-source services private to the edX organization, and are unsupported in Open edX. Enabling these environment variables will result in undefined behavior in Open edX installations: @@ -96,18 +119,101 @@ Example build syntax with a single environment variable: For more information see the document: `Micro-frontend applications in Open edX `__. +Cloning and Startup +=================== + +.. code-block:: + + + 1. Clone your new repo: + + ``git clone https://github.com/openedx/frontend-app-account.git`` + + 2. Use node v18.x. + + The current version of the micro-frontend build scripts support node 18. + Using other major versions of node *may* work, but this is unsupported. For + convenience, this repository includes an .nvmrc file to help in setting the + correct node version via `nvm `_. + + 3. Install npm dependencies: + + ``cd frontend-app-account && npm ci`` + + 4. Start the dev server: + + ``npm start`` + Known Issues ------------- +=========== None Development Roadmap -------------------- +=================== We don't have anything planned for the core of the MFE (the account settings page) - this MFE is currently in maintenance mode. There may be a replacement for IDV coming down the pipe, so that may be DEPRed. In the future, it's possible that demographics could be modeled as a plugin rather than being hard-coded into this MFE. +License +======= + +The code in this repository is licensed under the AGPLv3 unless otherwise +noted. + +Please see `LICENSE `_ for details. + +Contributing +============ + +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. + + +Getting Help +=========== + +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-account/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 Open edX Code of Conduct +============================ + +All community members are expected to follow the `Open edX Code of Conduct`_. + +.. _Open edX Code of Conduct: https://openedx.org/code-of-conduct/ + +Reporting Security Issues +========================= + +Please do not report security issues in public. Please email security@openedx.org. ==============================