{"id":20037813,"url":"https://github.com/openedx/frontend-app-account","last_synced_at":"2025-04-10T03:49:59.308Z","repository":{"id":37662468,"uuid":"183046430","full_name":"openedx/frontend-app-account","owner":"openedx","description":"Open edX micro-frontend application for managing user account information.","archived":false,"fork":false,"pushed_at":"2025-03-21T15:16:04.000Z","size":19285,"stargazers_count":19,"open_issues_count":31,"forks_count":136,"subscribers_count":65,"default_branch":"master","last_synced_at":"2025-03-21T18:03:11.806Z","etag":null,"topics":["pr-sandboxes-enabled"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/openedx.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-04-23T15:40:26.000Z","updated_at":"2025-03-21T15:15:09.000Z","dependencies_parsed_at":"2024-01-22T01:32:27.682Z","dependency_job_id":"15906013-07fa-4bff-bc6b-0aa3bd95cfed","html_url":"https://github.com/openedx/frontend-app-account","commit_stats":null,"previous_names":["edx/frontend-app-account"],"tags_count":34,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openedx%2Ffrontend-app-account","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openedx%2Ffrontend-app-account/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openedx%2Ffrontend-app-account/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openedx%2Ffrontend-app-account/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openedx","download_url":"https://codeload.github.com/openedx/frontend-app-account/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248154998,"owners_count":21056542,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["pr-sandboxes-enabled"],"created_at":"2024-11-13T10:22:39.415Z","updated_at":"2025-04-10T03:49:59.287Z","avatar_url":"https://github.com/openedx.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"####################\nfrontend-app-account\n####################\n\n|ci-badge| |Codecov| |npm_version| |npm_downloads| |license| |semantic-release|\n\n\n********\nPurpose\n********\n\nThis is a micro-frontend application responsible for the display and updating of a user's account information.\n\nWhat is the domain of this MFE?\n\nIn this MFE: Private user settings UIs. Public facing profile is in a `separate MFE (Profile) \u003chttps://github.com/openedx/frontend-app-profile\u003e`_\n\n- Account settings page\n- IDV (Identity Verification)\n\n***************\nGetting Started\n***************\n\nPrerequisites\n=============\n\n`Tutor`_ is currently recommended as a development environment for your\nnew MFE. Please refer\nto the `relevant tutor-mfe documentation`_ to get started using it.\n\n.. _Tutor: https://github.com/overhangio/tutor\n\n.. _relevant tutor-mfe documentation: https://github.com/overhangio/tutor-mfe?tab=readme-ov-file#mfe-development\n\nPlugins\n=======\nThis MFE can be customized using `Frontend Plugin Framework \u003chttps://github.com/openedx/frontend-plugin-framework\u003e`_.\n\nThe parts of this MFE that can be customized in that manner are documented `here \u003c/src/plugin-slots\u003e`_.\n\nEnvironment Variables/Setup Notes\n=================================\n\nThis MFE is configured via the ``frontend-platform`` configuration module. For more information on MFE configuration see the `Configuration documentation`_.\n\nThe account settings micro-frontend also supports the following additional variable:\n\n``SUPPORT_URL``\n\nExample: ``https://support.example.com``\n\nThe fully-qualified URL to the support page in the target environment.\n\n``PASSWORD_RESET_SUPPORT_LINK``\n\nExamples:\n\n- ``https://support.edx.org/hc/en-us/articles/206212088-What-if-I-did-not-receive-a-password-reset-message-``\n\n- ``mailto:support@example.com``\n\nThe fully-qualified URL to the support page or email to request the support from in the target environment.\n\n``ENABLE_ACCOUNT_DELETION``\n\nExample: ``'false'`` | ``''`` (empty strings are true)\n\nEnable the account deletion option, defaults to true.\nTo disable account deletion set ``ENABLE_ACCOUNT_DELETION`` to ``'false'`` (string), otherwise it will default to true.\n\nExample build syntax with a single environment variable:\n\n.. code:: bash\n\n   NODE_ENV=development ACCESS_TOKEN_COOKIE_NAME='edx-jwt-cookie-header-payload' npm run build\n\nFor more information see the document: `Configuration documentation`_\n\n.. _Configuration documentation: https://openedx.github.io/frontend-platform/module-Config.html\n\nCloning and Startup\n===================\n\n.. code-block::\n\n\n  1. Clone your new repo:\n\n    ``git clone https://github.com/openedx/frontend-app-account.git``\n\n  2. Use node v18.x.\n\n    The current version of the micro-frontend build scripts support node 18.\n    Using other major versions of node *may* work, but this is unsupported.  For\n    convenience, this repository includes an .nvmrc file to help in setting the\n    correct node version via `nvm \u003chttps://github.com/nvm-sh/nvm\u003e`_.\n\n  3. Install npm dependencies:\n\n    ``cd frontend-app-account \u0026\u0026 npm ci``\n\n  4. Start the dev server:\n\n    ``npm start``\n\nLocal module development\n=========================\n\nTo develop locally on modules that are installed into this app, you'll need to create a ``module.config.js``\nfile (which is git-ignored) that defines where to find your local modules, for instance:\n\n.. code-block:: js\n\n   module.exports = {\n     /*\n     Modules you want to use from local source code.  Adding a module here means that when this app\n     runs its build, it'll resolve the source from peer directories of this app.\n\n     moduleName: the name you use to import code from the module.\n     dir: The relative path to the module's source code.\n     dist: The sub-directory of the source code where it puts its build artifact.  Often \"dist\", though you\n       may want to use \"src\" if the module installs React as a peer/dev dependency.\n     */\n     localModules: [\n        { moduleName: '@openedx/paragon/scss', dir: '../paragon', dist: 'scss' },\n        { moduleName: '@openedx/paragon', dir: '../paragon', dist: 'dist' },\n        { moduleName: '@openedx/frontend-enterprise', dir: '../frontend-enterprise', dist: 'src' },\n        { moduleName: '@openedx/frontend-platform', dir: '../frontend-platform', dist: 'dist' },\n     ],\n   };\n\nSee https://github.com/openedx/frontend-build#local-module-configuration-for-webpack for more details.\n\nKnown Issues\n===========\n\nNone\n\nDevelopment Roadmap\n===================\n\nWe don't have anything planned for the core of the MFE (the account settings page) - this MFE is currently in maintenance mode.\nThere may be a replacement for IDV coming down the pipe, so that may be DEPRed.\n\nLicense\n=======\n\nThe code in this repository is licensed under the AGPLv3 unless otherwise\nnoted.\n\nPlease see `LICENSE \u003cLICENSE\u003e`_ for details.\n\nContributing\n============\n\nContributions are very welcome.  Please read `How To Contribute`_ for details.\n\n.. _How To Contribute: https://openedx.org/r/how-to-contribute\n\nThis project is currently accepting all types of contributions, bug fixes,\nsecurity fixes, maintenance work, or new features.  However, please make sure\nto have a discussion about your new feature idea with the maintainers prior to\nbeginning development to maximize the chances of your change being accepted.\nYou can start a conversation by creating a new issue on this repo summarizing\nyour idea.\n\n\nGetting Help\n===========\n\nIf you're having trouble, we have discussion forums at\nhttps://discuss.openedx.org where you can connect with others in the community.\n\nOur real-time conversations are on Slack. You can request a `Slack\ninvitation`_, then join our `community Slack workspace`_.  Because this is a\nfrontend repository, the best place to discuss it would be in the `#wg-frontend\nchannel`_.\n\nFor anything non-trivial, the best path is to open an issue in this repository\nwith as many details about the issue you are facing as you can provide.\n\nhttps://github.com/openedx/frontend-app-account/issues\n\nFor more information about these options, see the `Getting Help`_ page.\n\n.. _Slack invitation: https://openedx.org/slack\n.. _community Slack workspace: https://openedx.slack.com/\n.. _#wg-frontend channel: https://openedx.slack.com/archives/C04BM6YC7A6\n.. _Getting Help: https://openedx.org/community/connect\n\n\nThe Open edX Code of Conduct\n============================\n\nAll community members are expected to follow the `Open edX Code of Conduct`_.\n\n.. _Open edX Code of Conduct: https://openedx.org/code-of-conduct/\n\nPeople\n======\nThe assigned maintainers for this component and other project details may be found in Backstage or from inspecting catalog-info.yaml.\n\nReporting Security Issues\n=========================\n\nPlease do not report security issues in public. Please email security@openedx.org.\n\n==============================\n\n.. |ci-badge| image:: https://github.com/openedx/edx-developer-docs/actions/workflows/ci.yml/badge.svg\n   :target: https://github.com/openedx/edx-developer-docs/actions/workflows/ci.yml\n   :alt: Continuous Integration\n.. |Codecov| image:: https://img.shields.io/codecov/c/github/edx/frontend-app-account\n   :target: https://codecov.io/gh/edx/frontend-app-account\n.. |npm_version| image:: https://img.shields.io/npm/v/@edx/frontend-app-account.svg\n   :target: @edx/frontend-app-account\n.. |npm_downloads| image:: https://img.shields.io/npm/dt/@edx/frontend-app-account.svg\n   :target: @edx/frontend-app-account\n.. |license| image:: https://img.shields.io/npm/l/@edx/frontend-app-account.svg\n   :target: @edx/frontend-app-account\n.. |semantic-release| image:: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg\n   :target: https://github.com/semantic-release/semantic-release\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenedx%2Ffrontend-app-account","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenedx%2Ffrontend-app-account","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenedx%2Ffrontend-app-account/lists"}