56f5d655c6
* build: switch from travis to Github actions. Subsequent commits will clean up some of the 'npm-dist' code that we're no longer using. * build: remove npm distribution from repository Once upon a time, we published the components of the profile MFE to NPM because we believed we might want to embed them in frontend-app-learner-portal. We abandoned that idea about two years ago, but never cleaned up the experiment of publishing the MFE to npm. This commit does that. The prior commit on this branch disabled it by cutting over from travis to github actions - this commit just finishes the job. * fix: cleaning up a bad URL for order history. * docs: cleaning up a documentation URL in openedx.yml * fix: removing download of Roboto font None of our other MFEs do this; it was left over from an early design decision. It also doesn't appear to be having any effect, as I think this font is included via Paragon, if at all. It may also be that it's a secondary font choice after something else already available. Regardless, removing these two lines had no effect on the look and feel of the MFE, and reduces bundle size. * fix: using updated logo instead of pre-rebrand edX logo. This now uses the FAVICON_URL environment variable like all our other MFEs.
58 lines
2.1 KiB
ReStructuredText
Executable File
58 lines
2.1 KiB
ReStructuredText
Executable File
|Build Status| |Codecov| |license|
|
|
|
|
frontend-app-profile
|
|
====================
|
|
|
|
This is a micro-frontend application responsible for the display and updating of user profiles. Please tag **@edx/arch-fed** on any PRs or issues.
|
|
|
|
When 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.
|
|
|
|
When a user views someone else's profile, they see all those fields that that user set as public.
|
|
|
|
----------
|
|
|
|
Development
|
|
-----------
|
|
|
|
Start Devstack
|
|
^^^^^^^^^^^^^^
|
|
|
|
To use this application `devstack <https://github.com/edx/devstack>`__ must be running and you must be logged into it.
|
|
|
|
- Start devstack
|
|
- Log in (http://localhost:18000/login)
|
|
|
|
Start the development server
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
In this project, install requirements and start the development server by running:
|
|
|
|
.. code:: bash
|
|
|
|
npm install
|
|
npm start # The server will run on port 1995
|
|
|
|
Once the dev server is up visit http://localhost:1995/u/staff.
|
|
|
|
----------
|
|
|
|
Configuration and Deployment
|
|
----------------------------
|
|
|
|
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:
|
|
|
|
.. code:: bash
|
|
|
|
NODE_ENV=production ACCESS_TOKEN_COOKIE_NAME='edx-jwt-cookie-header-payload' npm run build
|
|
|
|
|
|
For more information see the document: `Micro-frontend applications in Open
|
|
edX <https://edx.readthedocs.io/projects/edx-developer-docs/en/latest/micro-frontends-in-open-edx.html>`__.
|
|
|
|
.. |Build Status| image:: https://api.travis-ci.org/edx/frontend-app-profile.svg?branch=master
|
|
:target: https://travis-ci.org/edx/frontend-app-profile
|
|
.. |Codecov| image:: https://img.shields.io/codecov/c/github/edx/frontend-app-profile
|
|
:target: https://codecov.io/gh/edx/frontend-app-profile
|
|
.. |license| image:: https://img.shields.io/npm/l/@edx/frontend-app-profile.svg
|
|
:target: @edx/frontend-app-profile
|