{"id":20037726,"url":"https://github.com/openedx/frontend-app-learner-record","last_synced_at":"2025-05-05T06:31:14.793Z","repository":{"id":37863190,"uuid":"387573504","full_name":"openedx/frontend-app-learner-record","owner":"openedx","description":"Open edX micro-frontend application for viewing learner records","archived":false,"fork":false,"pushed_at":"2024-11-11T07:33:44.000Z","size":7752,"stargazers_count":5,"open_issues_count":7,"forks_count":16,"subscribers_count":60,"default_branch":"master","last_synced_at":"2024-11-11T08:28:23.121Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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":"2021-07-19T19:30:14.000Z","updated_at":"2024-11-11T07:33:49.000Z","dependencies_parsed_at":"2023-10-20T22:25:23.214Z","dependency_job_id":"bdd87285-2c42-4237-ae30-8adc4e479dd4","html_url":"https://github.com/openedx/frontend-app-learner-record","commit_stats":null,"previous_names":[],"tags_count":20,"template":false,"template_full_name":"openedx/frontend-template-application","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openedx%2Ffrontend-app-learner-record","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openedx%2Ffrontend-app-learner-record/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openedx%2Ffrontend-app-learner-record/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openedx%2Ffrontend-app-learner-record/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openedx","download_url":"https://codeload.github.com/openedx/frontend-app-learner-record/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224428778,"owners_count":17309584,"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":[],"created_at":"2024-11-13T10:21:23.056Z","updated_at":"2025-05-05T06:31:14.785Z","avatar_url":"https://github.com/openedx.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"###########################\nfrontend-app-learner-record\n###########################\n\n|Build Status| |Codecov| |license|\n\n*******\nPurpose\n*******\n\nThe Learner Record provides information about the enrolled programs for a user.\nIt contains views for a learners current status in a program, their current grade, and the ability to share any earned credentials either publically or with institutions.\n\nVerifiable Credentials\n======================\n\nOptionally, this micro-frontend allows `verifiable credentials`_ creation for already achieved Open edX credentials (currently, program certificates only).\n\nThis is the Learner Record micro-frontend, currently under development by `edX \u003chttps://www.edx.org\u003e`_.\n\n.. _verifiable credentials: https://en.wikipedia.org/wiki/Verifiable_credentials\n\n***************\nGetting Started\n***************\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\nDeveloping\n==========\n\nOne Time Setup\n==============\n\n.. code-block::\n\n  # Clone the repository via SSH\n  git clone git@github.com:openedx/frontend-app-learner-record.git\n\n  # Enter the directory\n  cd frontend-app-learner-record\n\n  # Clean Install dependencies\n  npm ci\n\n  # Start the Learner Record MFE\n  npm start\n\nThe page will then be hosted on http://localhost:1990/\n\nEvery time you develop something in this repo\n=============================================\n.. code-block::\n\n  # Grab the latest code\n  git fetch\n  git pull\n\n  # Make a new branch for your changes\n  git checkout -b \u003cyour_github_username\u003e/\u003cshort_description\u003e\n\n  # Clean install/update the dev requirements\n  npm ci\n\n  # Start the Learner Record MFE\n  npm start\n\n  # Using your favorite editor, edit the code to make your change.\n  vim ...\n\n  # Run the tests after making changes (to verify the status before you make any changes)\n  npm test\n\n  # Commit all your changes\n  git commit ...\n  git push\n\n  # Open a PR and ask for review after the github CI has passed.\n\nEnvironment Variables/Setup Notes\n=================================\n\nCurrently, this MFE is not intergrated into the devstack, and must be run locally. This MFE requires credentials to be running, and will use a REST API from the Credentials IDA located at `credentials/apps/records/rest_api`.\n\nCredentials requires configuring a Django setting to support directing traffic to the Learner Record MFE:\n\n* ``LEARNER_RECORD_MFE_RECORDS_PAGE_URL`` -- The base URL of the Learner Record MFE\n\nFor more info, see the Learner Records documentation on ReadTheDocs: https://edx-credentials.readthedocs.io/en/latest/learner_records.html.\n\nThis MFE has a setting of its own:\n\n* ``SUPPORT_URL_LEARNER_RECORDS`` -- A link to a help/support center for learners who run into problems whilst trying to share their records\n\nVerifiable Credentials\n......................\n\nAn optional feature. It is behind a feature flag.\nThe feature introduces two environment variables:\n\n* ``ENABLE_VERIFIABLE_CREDENTIALS`` -- Toggles the Verifiable Credentials feature (used by the Credentials IDA and this micro-frontend)\n* ``SUPPORT_URL_VERIFIABLE_CREDENTIALS`` -- A link to a help/support center for learners who run into problems while trying to create their verifiable credential\n\nThe Verifiable Credentials UI is a functional addition to the corresponding backend app. It will use a REST API from the Credentials IDA located at `credentials/apps/verifiable_credentials/rest_api`.\n\n\nProject Structure\n=================\n\nThe source for this project is organized into nested submodules according to the ADR `Feature-based Application Organization \u003chttps://github.com/edx/frontend-template-application/blob/master/docs/decisions/0002-feature-based-application-organization.rst\u003e`_.\n\nDeploying\n=========\n\n**Production Build**\n\nThe production build is created with ``npm run build``.\n\nGeneral deployment information can be found in the `Microfrontend onboarding`_ documentation, along with other MFE implementation details.\n\n.. _Microfrontend onboarding: https://openedx.atlassian.net/wiki/spaces/FEDX/pages/2629829454/Micro+Frontend+MFE+Onboarding#Deployment\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\ncommunity.\n\nOur real-time conversations are on Slack. You can request a `Slack\ninvitation`_, then join our `community Slack workspace`_.\n\nFor anything non-trivial, the best path is to open an issue in this\nrepository with as many details about the issue you are facing as you\ncan provide: https://github.com/openedx/frontend-app-learner-record/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.. _Getting Help: https://openedx.org/getting-help\n\nLicense\n=======\n\nThe code in this repository is licensed under the `GNU AFFERO GENERAL PUBLIC LICENSE` unless\notherwise noted.\n\nPlease see `LICENSE.txt \u003cLICENSE.txt\u003e`_ for details.\n\nContributing\n============\n\nContributions are very welcome.\nPlease read `How To Contribute \u003chttps://openedx.org/r/how-to-contribute\u003e`_ for details.\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============================\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://open-edx-backstage.herokuapp.com/catalog/default/component/{{ cookiecutter.repo_name }}\n\nReporting Security Issues\n=========================\n\nPlease do not report security issues in public. Please email security@openedx.org.\n\n.. |Build Status| image:: https://api.travis-ci.com/edx/frontend-app-learner-record.svg?branch=master\n   :target: https://travis-ci.com/edx/frontend-app-learner-record\n.. |Codecov| image:: https://codecov.io/gh/edx/frontend-app-learner-record/branch/master/graph/badge.svg\n   :target: https://codecov.io/gh/edx/frontend-app-learner-record\n.. |license| image:: https://img.shields.io/npm/l/@edx/frontend-app-learner-record.svg\n   :target: https://github.com/openedx/frontend-app-learner-record/blob/master/LICENSE\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenedx%2Ffrontend-app-learner-record","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenedx%2Ffrontend-app-learner-record","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenedx%2Ffrontend-app-learner-record/lists"}