{"id":20037847,"url":"https://github.com/openedx/frontend-app-profile","last_synced_at":"2025-04-06T07:14:29.915Z","repository":{"id":36974833,"uuid":"165106430","full_name":"openedx/frontend-app-profile","owner":"openedx","description":"Open edX micro-frontend application for managing user profile information.","archived":false,"fork":false,"pushed_at":"2025-03-19T11:15:39.000Z","size":20592,"stargazers_count":13,"open_issues_count":17,"forks_count":110,"subscribers_count":66,"default_branch":"master","last_synced_at":"2025-03-21T18:03:11.892Z","etag":null,"topics":["frontend","frontend-app","micro-frontend"],"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":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-01-10T17:55:59.000Z","updated_at":"2025-03-18T11:02:31.000Z","dependencies_parsed_at":"2023-10-17T07:12:25.099Z","dependency_job_id":"d1d0b75d-7567-4001-a2cf-9bc9291a4d5c","html_url":"https://github.com/openedx/frontend-app-profile","commit_stats":null,"previous_names":["edx/frontend-app-profile"],"tags_count":127,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openedx%2Ffrontend-app-profile","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openedx%2Ffrontend-app-profile/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openedx%2Ffrontend-app-profile/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openedx%2Ffrontend-app-profile/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openedx","download_url":"https://codeload.github.com/openedx/frontend-app-profile/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247445681,"owners_count":20939961,"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":["frontend","frontend-app","micro-frontend"],"created_at":"2024-11-13T10:23:21.223Z","updated_at":"2025-04-06T07:14:29.882Z","avatar_url":"https://github.com/openedx.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"#####################\nfrontend-app-profile\n#####################\n\n|license-badge| |status-badge| |ci-badge| |codecov-badge|\n\n.. |license-badge| image:: https://img.shields.io/github/license/openedx/frontend-app-profile.svg\n    :target: https://github.com/openedx/frontend-app-profile/blob/main/LICENSE\n    :alt: License\n\n.. |status-badge| image:: https://img.shields.io/badge/Status-Maintained-brightgreen\n\n.. |ci-badge| image:: https://github.com/openedx/frontend-app-profile/actions/workflows/ci.yml/badge.svg\n    :target: https://github.com/openedx/frontend-app-profile/actions/workflows/ci.yml\n    :alt: Continuous Integration\n\n.. |codecov-badge| image:: https://codecov.io/github/openedx/frontend-app-profile/coverage.svg?branch=main\n    :target: https://codecov.io/github/openedx/frontend-app-profile?branch=main\n    :alt: Codecov\n\n********\nPurpose\n********\n\nThis is a micro-frontend application responsible for the display and updating of user profiles.\n\nWhen a user views their own profile, they're given fields to edit their full name, location, primary spoken language, education, social links, and bio.  Each field also has a dropdown to select the visibility of that field - i.e., whether it can be viewed by other learners.\n\nWhen a user views someone else's profile, they see all those fields that that user set as public.\n\n***************\nGetting Started\n***************\n\nInstallation\n============\n\nFollow these steps to provision, run, and enable an instance of the\nProfile MFE for local development via the `devstack`_.\n\n.. _devstack: https://github.com/openedx/devstack#getting-started\n\n#. To use this application, `devstack \u003chttps://github.com/openedx/devstack\u003e`__ must be running and you must be logged into it.\n\n   * Start devstack\n   * Log in (http://localhost:18000/login)\n\n#. To run Profile, install requirements and start the development server by running:\n\n.. code-block::\n\n  1. Clone your new repo:\n\n    ``git clone https://github.com/openedx/frontend-app-profile.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-profile \u0026\u0026 npm ci``\n\n  4. Start the dev server:\n\n    ``npm start``\n     The server will run on port 1995\n\nOnce the dev server is up, visit http://localhost:1995/u/staff.\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\nConfiguration\n=============\n\nThis MFE is configured via node environment variables supplied at build time. See the .env file for the list of required environment variables. Example build syntax with a single environment variable:\n\n.. code-block::\n\n   NODE_ENV=production ACCESS_TOKEN_COOKIE_NAME='edx-jwt-cookie-header-payload' npm run build\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.  Please tag **@openedx/2u-infinity** on any PRs or issues.\n\nhttps://github.com/openedx/frontend-app-profile/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/getting-help\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\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======\n\nThe assigned maintainers for this component and other project details may be\nfound in `Backstage`_. Backstage pulls this data from the ``catalog-info.yaml``\nfile in this repo.\n\n.. _Backstage: https://backstage.herokuapp.com/catalog/default/component/frontend-app-profile\n\nReporting Security Issues\n=========================\n\nPlease do not report security issues in public.  Email security@openedx.org instead.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenedx%2Ffrontend-app-profile","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenedx%2Ffrontend-app-profile","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenedx%2Ffrontend-app-profile/lists"}