Skip to content

Latest commit

 

History

History
73 lines (47 loc) · 3.79 KB

README.rst

File metadata and controls

73 lines (47 loc) · 3.79 KB
Raw

Build Status Codecov npm_version npm_downloads license semantic-release

frontend-app-ecommerce

Please tag @edx/revenue-squad on any PRs or issues.

Introduction

This is a micro-frontend application responsible for the display of an authenticated user's order history and receipt page.

Installation

This MFE is bundled with Devstack, see the Getting Started section for setup instructions.

  1. Install Devstack using the Getting Started instructions.

  2. Start up Devstack, if it's not already started.

  3. Log in to Devstack (http://localhost:18000/login )

  4. Within this project, install requirements and start the development server:

    npm ci
npm start # The server will run on port 1996

    Note: We prefer npm ci over npm install to match the way CI and production builds work and avoid unintentional changes to package-lock.json when doing other work. Note, however, that using npm ci can obscure necessary updates to package-lock.json that may have accidentally been left out of prior commits. If npm install changes package-lock.json, those are changes that should be checked in.

  5. Once the dev server is up, visit http://localhost:1996 to access the MFE

    ./docs/images/localhost_preview.png

Environment Variables/Setup Notes

This MFE is configured via environment variables supplied at build time. All micro-frontends have a shared set of required environment variables, as documented in the Open edX Developer Guide under Required Environment Variables.

To have ecommerce send users to this receipt page (instead of its own), there are two items to set in ecommerce: 1) Django admin waffle flag: enable_receipts_via_ecommerce_mfe 2) ECOMMERCE_MICROFRONTEND_URL environment variable

This micro-frontend has no additional required environment variables.

Known Issues

None

Development Roadmap

This MFE is currently in maintenance mode, as we have no further development planned for it. However, if we want to pull more ecommerce interfaces out into a micro-frontend, this would be where they should live. Note that frontend-app-payment contains the checkout flow.

Anyone merging to this repository is expected to release and monitor their changes; if you are not able to do this DO NOT MERGE, please coordinate with someone who can to ensure that the changes are released.