Andal.LND/frontend-app-profile
6
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge master into PluggablePOCFeature (#908)

Browse Source 
---------

Co-authored-by: jsnwesson <jsnwesson@users.noreply.github.com>
This commit is contained in:
Jason Wesson
2023-11-07 20:03:44 -08:00
committed by GitHub
parent cd28310937
commit d5949f55c2
3 changed files with 60 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
README.rst
View File

@@ -1,5 +1,6 @@
#####################
frontend-app-profile
##########################
#####################
|license-badge| |status-badge| |ci-badge| |codecov-badge|
@@ -17,8 +18,9 @@ frontend-app-profile
:target: https://codecov.io/github/openedx/frontend-app-profile?branch=main
:alt: Codecov
********
Purpose
=======
********
This is a micro-frontend application responsible for the display and updating of user profiles.
@@ -26,11 +28,12 @@ When a user views their own profile, they're given fields to edit their full nam
When a user views someone else's profile, they see all those fields that that user set as public.
***************
Getting Started
===============
***************
Devstack Installation
---------------------
Installation
============
Follow these steps to provision, run, and enable an instance of the
Profile MFE for local development via the `devstack`_.
@@ -46,13 +49,30 @@ Profile MFE for local development via the `devstack`_.
.. code-block::
npm install
npm start # The server will run on port 1995
1. Clone your new repo:
``git clone https://github.com/openedx/frontend-app-profile.git``
2. Use node v18.x.
The current version of the micro-frontend build scripts support node 18.
Using other major versions of node *may* work, but this is unsupported. For
convenience, this repository includes an .nvmrc file to help in setting the
correct node version via `nvm <https://github.com/nvm-sh/nvm>`_.
3. Install npm dependencies:
``cd frontend-app-profile && npm ci``
4. Start the dev server:
``npm start``
The server will run on port 1995
Once the dev server is up, visit http://localhost:1995/u/staff.
Configuration
-------------
=============
This 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:

60
package-lock.json generated
View File

@@ -10,7 +10,7 @@
"license": "AGPL-3.0",
"dependencies": {
"@edx/brand": "npm:@openedx/brand-openedx@^1.2.2",
"@edx/frontend-component-footer": "12.5.0",
"@edx/frontend-component-footer": "12.5.1",
"@edx/frontend-component-header": "4.8.0",
"@edx/frontend-platform": "5.6.1",
"@edx/paragon": "^20.44.0",
@@ -48,7 +48,7 @@
"@commitlint/cli": "17.8.1",
"@commitlint/config-angular": "17.8.1",
"@edx/browserslist-config": "^1.1.1",
"@edx/frontend-build": "13.0.1",
"@edx/frontend-build": "13.0.4",
"@edx/reactifex": "2.2.0",
"@testing-library/react": "12.1.5",
"@wojtekmaj/enzyme-adapter-react-17": "0.8.0",
@@ -2395,9 +2395,9 @@
}
},
"node_modules/@csstools/cascade-layer-name-parser": {
"version": "1.0.4",
"resolved": "https://registry.npmjs.org/@csstools/cascade-layer-name-parser/-/cascade-layer-name-parser-1.0.4.tgz",
"integrity": "sha512-zXMGsJetbLoXe+gjEES07MEGjL0Uy3hMxmnGtVBrRpVKr5KV9OgCB09zr/vLrsEtoVQTgJFewxaU8IYSAE4tjg==",
"version": "1.0.5",
"resolved": "https://registry.npmjs.org/@csstools/cascade-layer-name-parser/-/cascade-layer-name-parser-1.0.5.tgz",
"integrity": "sha512-v/5ODKNBMfBl0us/WQjlfsvSlYxfZLhNMVIsuCPib2ulTwGKYbKJbwqw671+qH9Y4wvWVnu7LBChvml/wBKjFg==",
"funding": [
{
"type": "github",
@@ -2412,8 +2412,8 @@
"node": "^14 || ^16 || >=18"
},
"peerDependencies": {
"@csstools/css-parser-algorithms": "^2.3.1",
"@csstools/css-tokenizer": "^2.2.0"
"@csstools/css-parser-algorithms": "^2.3.2",
"@csstools/css-tokenizer": "^2.2.1"
}
},
"node_modules/@csstools/css-parser-algorithms": {
@@ -2487,9 +2487,9 @@
},
"node_modules/@edx/brand": {
"name": "@openedx/brand-openedx",
"version": "1.2.2",
"resolved": "https://registry.npmjs.org/@openedx/brand-openedx/-/brand-openedx-1.2.2.tgz",
"integrity": "sha512-mBvxR7aB9290j9+h3d/9G8VkG1b8ecLSmlxc0vskfm7DL/fKUzFmHAj3PI7Z4kkwCQOL4QT5mJHJKC0ZFf7qvQ=="
"version": "1.2.3",
"resolved": "https://registry.npmjs.org/@openedx/brand-openedx/-/brand-openedx-1.2.3.tgz",
"integrity": "sha512-Dn9CtpC8fovh++Xi4NF5NJoeR9yU2yXZnV9IujxIyGd/dn0Phq5t6dzJVfupwq09mpDnzJv7egA8Znz/3ljO+w=="
},
"node_modules/@edx/browserslist-config": {
"version": "1.2.0",
@@ -2511,9 +2511,9 @@
}
},
"node_modules/@edx/frontend-build": {
"version": "13.0.1",
"resolved": "https://registry.npmjs.org/@edx/frontend-build/-/frontend-build-13.0.1.tgz",
"integrity": "sha512-XoR2Yt9FUXKfbah0AirS5ckARc+j0jLzTRtvpsaqg4bFhPIbv0HragqoLs8Y8SQfn4sZy2v6EZ3pA09P4OBwDg==",
"version": "13.0.4",
"resolved": "https://registry.npmjs.org/@edx/frontend-build/-/frontend-build-13.0.4.tgz",
"integrity": "sha512-c6i4h19as3vNMIgo+vLNhBk3cM4TOUtBrgYmLrzLtLcWsNZUojnrufrLOdtWmNNKylcBUI9Lvyv++/KrtfJo9w==",
"dependencies": {
"@babel/cli": "7.22.5",
"@babel/core": "7.22.5",
@@ -2555,7 +2555,7 @@
"jest": "26.6.3",
"mini-css-extract-plugin": "1.6.2",
"postcss": "8.4.31",
"postcss-custom-media": "10.0.1",
"postcss-custom-media": "10.0.2",
"postcss-loader": "7.3.3",
"postcss-rtlcss": "4.0.8",
"react-dev-utils": "12.0.1",
@@ -2581,9 +2581,9 @@
}
},
"node_modules/@edx/frontend-component-footer": {
"version": "12.5.0",
"resolved": "https://registry.npmjs.org/@edx/frontend-component-footer/-/frontend-component-footer-12.5.0.tgz",
"integrity": "sha512-kICrEglLQyMtM3Rp0Hw2ewMsqRtBojNrNgbNbQuQTjBFAWu3N137+WBb1Hljko59kJ97iiY8cIIEit9CnM3YnA==",
"version": "12.5.1",
"resolved": "https://registry.npmjs.org/@edx/frontend-component-footer/-/frontend-component-footer-12.5.1.tgz",
"integrity": "sha512-bLXfSDyyf8z+n4VXkraQ98qhkc+ZXuvRy65kXUE3s560oDv0qdiKU054W8uPY6wtsdu4WQ50C/Mluxzd60UKUg==",
"dependencies": {
"@edx/paragon": "^21.3.1",
"@fortawesome/fontawesome-svg-core": "6.4.2",
@@ -2601,9 +2601,9 @@
}
},
"node_modules/@edx/frontend-component-footer/node_modules/@edx/paragon": {
"version": "21.5.5",
"resolved": "https://registry.npmjs.org/@edx/paragon/-/paragon-21.5.5.tgz",
"integrity": "sha512-M0t6oPZAS0fzcG5rxVr+1i0HMRKTiTUlN9qTxkn9sjPff4mSGKWI9t3/5VIlnls6aaX2GS6vu61n43dJV+4EXg==",
"version": "21.5.6",
"resolved": "https://registry.npmjs.org/@edx/paragon/-/paragon-21.5.6.tgz",
"integrity": "sha512-CWR9mFBQAnZ29GeP8igPk3dBLgIQmZJ6tZQiou6855TjHIXcvgmbIvtchKw9SgzhW+D5B0hQJet94zsm+GG/Rg==",
"dependencies": {
"@fortawesome/fontawesome-svg-core": "^6.1.1",
"@fortawesome/react-fontawesome": "^0.1.18",
@@ -7312,9 +7312,9 @@
}
},
"node_modules/caniuse-lite": {
"version": "1.0.30001553",
"resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001553.tgz",
"integrity": "sha512-N0ttd6TrFfuqKNi+pMgWJTb9qrdJu4JSpgPFLe/lrD19ugC6fZgF0pUewRowDwzdDnb9V41mFcdlYgl/PyKf4A==",
"version": "1.0.30001558",
"resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001558.tgz",
"integrity": "sha512-/Et7DwLqpjS47JPEcz6VnxU9PwcIdVi0ciLXRWBQdj1XFye68pSQYpV0QtPTfUKWuOaEig+/Vez2l74eDc1tPQ==",
"funding": [
{
"type": "opencollective",
@@ -16802,9 +16802,9 @@
}
},
"node_modules/postcss-custom-media": {
"version": "10.0.1",
"resolved": "https://registry.npmjs.org/postcss-custom-media/-/postcss-custom-media-10.0.1.tgz",
"integrity": "sha512-fil7cosvzlIAYmZJPtNFcTH0Er7a3GveEK4q5Y/L24eWQHmiw8Fv/E5DMkVpdbNjkGzJxrvowOSt/Il9HZ06VQ==",
"version": "10.0.2",
"resolved": "https://registry.npmjs.org/postcss-custom-media/-/postcss-custom-media-10.0.2.tgz",
"integrity": "sha512-zcEFNRmDm2fZvTPdI1pIW3W//UruMcLosmMiCdpQnrCsTRzWlKQPYMa1ud9auL0BmrryKK1+JjIGn19K0UjO/w==",
"funding": [
{
"type": "github",
@@ -16816,10 +16816,10 @@
}
],
"dependencies": {
"@csstools/cascade-layer-name-parser": "^1.0.4",
"@csstools/css-parser-algorithms": "^2.3.1",
"@csstools/css-tokenizer": "^2.2.0",
"@csstools/media-query-list-parser": "^2.1.4"
"@csstools/cascade-layer-name-parser": "^1.0.5",
"@csstools/css-parser-algorithms": "^2.3.2",
"@csstools/css-tokenizer": "^2.2.1",
"@csstools/media-query-list-parser": "^2.1.5"
},
"engines": {
"node": "^14 || ^16 || >=18"

4
package.json
View File

@@ -29,7 +29,7 @@
],
"dependencies": {
"@edx/brand": "npm:@openedx/brand-openedx@^1.2.2",
"@edx/frontend-component-footer": "12.5.0",
"@edx/frontend-component-footer": "12.5.1",
"@edx/frontend-component-header": "4.8.0",
"@edx/frontend-platform": "5.6.1",
"@edx/paragon": "^20.44.0",
@@ -67,7 +67,7 @@
"@commitlint/cli": "17.8.1",
"@commitlint/config-angular": "17.8.1",
"@edx/browserslist-config": "^1.1.1",
"@edx/frontend-build": "13.0.1",
"@edx/frontend-build": "13.0.4",
"@edx/reactifex": "2.2.0",
"@testing-library/react": "12.1.5",
"@wojtekmaj/enzyme-adapter-react-17": "0.8.0",