diff --git a/README.rst b/README.rst index bd144d4..82ed36e 100644 --- a/README.rst +++ b/README.rst @@ -1,10 +1,10 @@ ########################### frontend-app-learner-record -############################ +########################### |Build Status| |Codecov| |license| -******** +******* Purpose ******* @@ -29,19 +29,20 @@ Developing One Time Setup ============== + .. code-block:: # Clone the repository via SSH git clone git@github.com:openedx/frontend-app-learner-record.git # Enter the directory - cd frontend-app-learner-record + cd frontend-app-learner-record # Clean Install dependencies - npm ci + npm ci # Start the Learner Record MFE - npm start + npm start The page will then be hosted on http://localhost:1990/ @@ -50,27 +51,27 @@ Every time you develop something in this repo .. code-block:: # Grab the latest code - git fetch - git pull + git fetch + git pull # Make a new branch for your changes - git checkout -b / + git checkout -b / # Clean install/update the dev requirements - npm ci + npm ci # Start the Learner Record MFE - npm start + npm start # Using your favorite editor, edit the code to make your change. - vim ... + vim ... # Run the tests after making changes (to verify the status before you make any changes) - npm test + npm test # Commit all your changes - git commit ... - git push + git commit ... + git push # Open a PR and ask for review after the github CI has passed. @@ -81,7 +82,7 @@ Currently, this MFE is not intergrated into the devstack, and must be run locall Credentials requires configuring a Django setting to support directing traffic to the Learner Record MFE: -* ``LEARNER_RECORD_MFE_RECORDS_PAGE_URL`` -- The base URL of the Learne Record MFE +* ``LEARNER_RECORD_MFE_RECORDS_PAGE_URL`` -- The base URL of the Learner Record MFE For more info, see the Learner Records documentation on ReadTheDocs: https://edx-credentials.readthedocs.io/en/latest/learner_records.html. @@ -102,7 +103,7 @@ The Verifiable Credentials UI is a functional addition to the corresponding back Project Structure -================== +================= The source for this project is organized into nested submodules according to the ADR `Feature-based Application Organization `_. @@ -129,9 +130,7 @@ invitation`_, then join our `community Slack workspace`_. 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-learner-record/issues +can provide: https://github.com/openedx/frontend-app-learner-record/issues For more information about these options, see the `Getting Help`_ page. @@ -176,7 +175,7 @@ file in this repo. .. _Backstage: https://open-edx-backstage.herokuapp.com/catalog/default/component/{{ cookiecutter.repo_name }} Reporting Security Issues -========================== +========================= Please do not report security issues in public. Please email security@openedx.org. diff --git a/package-lock.json b/package-lock.json index 673351a..73db8f3 100644 --- a/package-lock.json +++ b/package-lock.json @@ -21,7 +21,7 @@ "@fortawesome/react-fontawesome": "0.2.0", "axios": "0.27.2", "babel-polyfill": "6.26.0", - "core-js": "3.25.3", + "core-js": "3.33.3", "js-cookie": "3.0.5", "lodash": "4.17.21", "prop-types": "15.8.1", @@ -37,7 +37,7 @@ }, "devDependencies": { "@edx/browserslist-config": "^1.2.0", - "@edx/frontend-build": "13.0.4", + "@edx/frontend-build": "13.0.8", "@edx/reactifex": "1.1.0", "@testing-library/jest-dom": "5.17.0", "@testing-library/react": "12.1.5", @@ -47,7 +47,7 @@ "husky": "7.0.4", "jest": "27.5.1", "resize-observer-polyfill": "^1.5.1", - "rosie": "2.1.0" + "rosie": "2.1.1" } }, "node_modules/@aashutoshrathi/word-wrap": { @@ -2150,9 +2150,9 @@ } }, "node_modules/@edx/frontend-build": { - "version": "13.0.4", - "resolved": "https://registry.npmjs.org/@edx/frontend-build/-/frontend-build-13.0.4.tgz", - "integrity": "sha512-c6i4h19as3vNMIgo+vLNhBk3cM4TOUtBrgYmLrzLtLcWsNZUojnrufrLOdtWmNNKylcBUI9Lvyv++/KrtfJo9w==", + "version": "13.0.8", + "resolved": "https://registry.npmjs.org/@edx/frontend-build/-/frontend-build-13.0.8.tgz", + "integrity": "sha512-TXUoF7BTIHe4h+W4Dt9+Gf8PXnfVJRwLKitEkpYUH5r4kDEJfyKKGYSbizkciGI+9QScbhm2u8Alv2agDXV1TA==", "dependencies": { "@babel/cli": "7.22.5", "@babel/core": "7.22.5", @@ -2196,17 +2196,17 @@ "postcss": "8.4.31", "postcss-custom-media": "10.0.2", "postcss-loader": "7.3.3", - "postcss-rtlcss": "4.0.8", + "postcss-rtlcss": "4.0.9", "react-dev-utils": "12.0.1", "react-refresh": "0.14.0", "resolve-url-loader": "5.0.0", - "sass": "1.65.1", + "sass": "1.69.5", "sass-loader": "13.3.2", "sharp": "0.32.6", "source-map-loader": "4.0.1", "style-loader": "3.3.3", "url-loader": "4.1.1", - "webpack": "5.88.2", + "webpack": "5.89.0", "webpack-bundle-analyzer": "4.9.1", "webpack-cli": "5.1.4", "webpack-dev-server": "4.15.1", @@ -2444,9 +2444,9 @@ } }, "node_modules/@edx/frontend-build/node_modules/@types/yargs": { - "version": "15.0.17", - "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-15.0.17.tgz", - "integrity": "sha512-cj53I8GUcWJIgWVTSVe2L7NJAB5XWGdsoMosVvUgv1jEnMbAcsbaCzt1coUcyi8Sda5PgTWAooG8jNyDTD+CWA==", + "version": "15.0.18", + "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-15.0.18.tgz", + "integrity": "sha512-DDi2KmvAnNsT/EvU8jp1UR7pOJojBtJ3GLZ/uw1MUq4VbbESppPWoHUY4h0OB4BbEbGJiyEsmUcuZDZtoR+ZwQ==", "dependencies": { "@types/yargs-parser": "*" } @@ -7084,9 +7084,9 @@ } }, "node_modules/caniuse-lite": { - "version": "1.0.30001561", - "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001561.tgz", - "integrity": "sha512-NTt0DNoKe958Q0BE0j0c1V9jbUzhBxHIEJy7asmGrpE0yG63KTV7PLHPnK2E1O9RsQrQ081I3NLuXGS6zht3cw==", + "version": "1.0.30001564", + "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001564.tgz", + "integrity": "sha512-DqAOf+rhof+6GVx1y+xzbFPeOumfQnhYzVnZD6LAXijR77yPtm9mfOcqOnT3mpnJiZVT+kwLAFnRlZcIz+c6bg==", "funding": [ { "type": "opencollective", @@ -7637,9 +7637,9 @@ } }, "node_modules/core-js": { - "version": "3.25.3", - "resolved": "https://registry.npmjs.org/core-js/-/core-js-3.25.3.tgz", - "integrity": "sha512-y1hvKXmPHvm5B7w4ln1S4uc9eV/O5+iFExSRUimnvIph11uaizFR8LFMdONN8hG3P2pipUfX4Y/fR8rAEtcHcQ==", + "version": "3.33.3", + "resolved": "https://registry.npmjs.org/core-js/-/core-js-3.33.3.tgz", + "integrity": "sha512-lo0kOocUlLKmm6kv/FswQL8zbkH7mVsLJ/FULClOhv8WRVmKLVcs6XPNQAzstfeJTCHMyButEwG+z1kHxHoDZw==", "hasInstallScript": true, "funding": { "type": "opencollective", @@ -15318,14 +15318,14 @@ } }, "node_modules/postcss-rtlcss": { - "version": "4.0.8", - "resolved": "https://registry.npmjs.org/postcss-rtlcss/-/postcss-rtlcss-4.0.8.tgz", - "integrity": "sha512-CR2sY889PHnX6K8rjW9FG4Qvm9UJsIekDakMtEYGH3zgFp9XADMeaKcA0hPOmkClNh0jWbkaPBm0jZ6fHmqkJQ==", + "version": "4.0.9", + "resolved": "https://registry.npmjs.org/postcss-rtlcss/-/postcss-rtlcss-4.0.9.tgz", + "integrity": "sha512-dCNKEf+FgTv+EA3XI8ysg2RnpS5s3/iZmU+9qpCNFxHU/BhK+4hz7jyCsCAfo0CLnDrMPtaQENhwb+EGm1wh7Q==", "dependencies": { - "rtlcss": "4.1.0" + "rtlcss": "4.1.1" }, "engines": { - "node": ">=12.0.0" + "node": ">=18.0.0" }, "peerDependencies": { "postcss": "^8.4.21" @@ -16719,9 +16719,9 @@ } }, "node_modules/rosie": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/rosie/-/rosie-2.1.0.tgz", - "integrity": "sha512-Dbzdc+prLXZuB/suRptDnBUY29SdGvND3bLg6cll8n7PNqzuyCxSlRfrkn8PqjS9n4QVsiM7RCvxCkKAkTQRjA==", + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/rosie/-/rosie-2.1.1.tgz", + "integrity": "sha512-2AXB7WrIZXtKMZ6Q/PlozqPF5nu/x7NEvRJZOblrJuprrPfm5gL8JVvJPj9aaib9F8IUALnLUFhzXrwEtnI5cQ==", "dev": true, "engines": { "node": ">=10" @@ -16736,9 +16736,9 @@ } }, "node_modules/rtlcss": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/rtlcss/-/rtlcss-4.1.0.tgz", - "integrity": "sha512-W+N4hh0nVqVrrn3mRkHakxpB+c9cQ4CRT67O39kgA+1DjyhrdsqyCqIuHXyvWaXn4/835n+oX3fYJCi4+G/06A==", + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/rtlcss/-/rtlcss-4.1.1.tgz", + "integrity": "sha512-/oVHgBtnPNcggP2aVXQjSy6N1mMAfHg4GSag0QtZBlD5bdDgAHwr4pydqJGd+SUCu9260+Pjqbjwtvu7EMH1KQ==", "dependencies": { "escalade": "^3.1.1", "picocolors": "^1.0.0", @@ -17135,9 +17135,9 @@ } }, "node_modules/sass": { - "version": "1.65.1", - "resolved": "https://registry.npmjs.org/sass/-/sass-1.65.1.tgz", - "integrity": "sha512-9DINwtHmA41SEd36eVPQ9BJKpn7eKDQmUHmpI0y5Zv2Rcorrh0zS+cFrt050hdNbmmCNKTW3hV5mWfuegNRsEA==", + "version": "1.69.5", + "resolved": "https://registry.npmjs.org/sass/-/sass-1.69.5.tgz", + "integrity": "sha512-qg2+UCJibLr2LCVOt3OlPhr/dqVHWOa9XtZf2OjbLs/T4VPSJ00udtgJxH3neXZm+QqX8B+3cU7RaLqp1iVfcQ==", "dependencies": { "chokidar": ">=3.0.0 <4.0.0", "immutable": "^4.0.0", @@ -19433,9 +19433,9 @@ } }, "node_modules/webpack": { - "version": "5.88.2", - "resolved": "https://registry.npmjs.org/webpack/-/webpack-5.88.2.tgz", - "integrity": "sha512-JmcgNZ1iKj+aiR0OvTYtWQqJwq37Pf683dY9bVORwVbUrDhLhdn/PlO2sHsFHPkj7sHNQF3JwaAkp49V+Sq1tQ==", + "version": "5.89.0", + "resolved": "https://registry.npmjs.org/webpack/-/webpack-5.89.0.tgz", + "integrity": "sha512-qyfIC10pOr70V+jkmud8tMfajraGCZMBWJtrmuBymQKCrLTRejBI8STDp1MCyZu/QTdZSeacCQYpYNQVOzX5kw==", "dependencies": { "@types/eslint-scope": "^3.7.3", "@types/estree": "^1.0.0", diff --git a/package.json b/package.json index 5fbfe7b..b49f674 100644 --- a/package.json +++ b/package.json @@ -45,7 +45,7 @@ "@fortawesome/react-fontawesome": "0.2.0", "axios": "0.27.2", "babel-polyfill": "6.26.0", - "core-js": "3.25.3", + "core-js": "3.33.3", "js-cookie": "3.0.5", "lodash": "4.17.21", "prop-types": "15.8.1", @@ -61,7 +61,7 @@ }, "devDependencies": { "@edx/browserslist-config": "^1.2.0", - "@edx/frontend-build": "13.0.4", + "@edx/frontend-build": "13.0.8", "@edx/reactifex": "1.1.0", "@testing-library/jest-dom": "5.17.0", "@testing-library/react": "12.1.5", @@ -71,6 +71,6 @@ "husky": "7.0.4", "jest": "27.5.1", "resize-observer-polyfill": "^1.5.1", - "rosie": "2.1.0" + "rosie": "2.1.1" } }