frontend-app-account

This is a micro-frontend application responsible for the display and updating of a user's account information. Please tag @edx/arch-team on any PRs or issues.

Development

Start Devstack

To use this application 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:

npm install
npm start # The server will run on port 1997

Once the dev server is up visit http://localhost:1997.

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:

NODE_ENV=development ACCESS_TOKEN_COOKIE_NAME='edx-jwt-cookie-header-payload' npm run build

For more information see the document: Micro-frontend applications in Open edX.

Notes

The production Webpack configuration for this repo uses Purgecss to remove unused CSS from the production css file. In webpack.prod.config.js the Purgecss plugin is configured to scan directories to determine what css selectors should remain. Currently the src/ directory is scanned along with all @edx/frontend-component* node modules and @edx/paragon. If you add and use a component in this repo that relies on HTML classes or ids for styling you must add it to the Purgecss configuration or it will be unstyled in the production build.