feat: [FC-0006] add Verifiable Credentials optional feature (#151)

* feat: [FC-0006] add Verifiable Credentials optional feature --------- Co-authored-by: Jason Wesson <[email protected]>
openedx · Aug 9, 2023 · 0f4c8ed · 0f4c8ed
1 parent 33c93a7
commit 0f4c8ed
Show file tree

Hide file tree

Showing 31 changed files with 3,994 additions and 5,773 deletions.
diff --git a/.env b/.env
@@ -21,3 +21,5 @@ USER_INFO_COOKIE_NAME=''
 SUPPORT_URL_LEARNER_RECORDS=''
 APP_ID=''
 MFE_CONFIG_API_URL=''
+ENABLE_VERIFIABLE_CREDENTIALS=''
+SUPPORT_URL_VERIFIABLE_CREDENTIALS=''
diff --git a/.env.development b/.env.development
@@ -23,3 +23,5 @@ SUPPORT_URL_LEARNER_RECORDS='https://support.edx.org/hc/en-us/sections/360001216
 USE_LR_MFE='true'
 APP_ID=''
 MFE_CONFIG_API_URL=''
+ENABLE_VERIFIABLE_CREDENTIALS='true'
+SUPPORT_URL_VERIFIABLE_CREDENTIALS=''
diff --git a/.env.test b/.env.test
@@ -18,3 +18,5 @@ SEGMENT_KEY=''
 SITE_NAME=localhost
 USER_INFO_COOKIE_NAME='edx-user-info'
 SUPPORT_URL_LEARNER_RECORDS=''
+ENABLE_VERIFIABLE_CREDENTIALS='true'
+SUPPORT_URL_VERIFIABLE_CREDENTIALS=''
diff --git a/README.rst b/README.rst
@@ -7,11 +7,18 @@ frontend-app-learner-record
 Purpose
 *******
 
-The Learner Record provides information about the enrolled programs for a user. 
+The Learner Record provides information about the enrolled programs for a user.
 It 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.
 
+Verifiable Credentials
+======================
+
+Optionally, this micro-frontend allows `verifiable credentials`_ creation for already achieved Open edX credentials (currently, program certificates only).
+
 This is the Learner Record micro-frontend, currently under development by `edX <https://www.edx.org>`_.
 
+.. _verifiable credentials: https://en.wikipedia.org/wiki/Verifiable_credentials
+
 Getting Started
 ***************
 
@@ -52,7 +59,7 @@ Every time you develop something in this repo
 
   # Start the Learner Record MFE
     npm start
-  
+
   # Using your favorite editor, edit the code to make your change.
     vim ...
 
@@ -81,6 +88,18 @@ This MFE has 2 flags of its own:
 * ``SUPPORT_URL_LEARNER_RECORDS`` -- A link to a help/support center for learners who run into problems whilst trying to share their records
 * ``USE_LR_MFE`` -- A toggle that when on, uses the MFE to host shared records instead of the the old UI inside of credentials
 
+Verifiable Credentials
+......................
+
+An optional feature. It is behind a feature flag.
+The feature introduces two environment variables:
+
+* ``ENABLE_VERIFIABLE_CREDENTIALS`` -- Toggles the Verifiable Credentials feature (used by the Credentials IDA and this micro-frontend)
+* ``SUPPORT_URL_VERIFIABLE_CREDENTIALS`` -- A link to a help/support center for learners who run into problems while trying to create their verifiable credential
+
+The 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`.
+
+
 Project Structure
 -----------------