frontend-app-enterprise-checkout

Purpose

This micro-frontend (MFE) supports a self-service B2B checkout experience to onboard and provision new enterprise customers via Stripe. It intends to be a top-of-funnel entrypoint, bridging the gap between a B2B marketing website and the authenticated Enterprise Admin/Learner experience. In addition to the Stripe integration, the MFE collects minimal information required to provision the enterprise customer, as well as handles user logistration (i.e., account registration and login support).

Getting Started

Devstack Installation

This MFE requires a devstack installation to run. Follow these steps to provision and run an instance of the Open edX platform powering this MFE via devstack.

In addition to the core services within devstack, you will need to setup the following enterprise Django IDAs:

• enterprise-access

Once you have a devstack installation in addition to the required enterprise Django IDAs, you may run this MFE directly from your local machine.

1. Start the devstack with:

   cd devstack
   make dev.pull
   make dev.provision
   make dev.up
   

2. Start the required enterprise Django IDAs, per their respective READMEs.

3. Start this MFE with:

   cd frontend-app-enterprise-checkout
   nvm use
   npm ci
   npm start
   

4. Finally, open the MFE in a browser

   Navigate to http://localhost:1989 to open the MFE.

Configuration

Note

[TODO]

Explicitly list anything that this MFE requires to function correctly. This includes:

• A list of both required and optional .env variables, and how they each affect the functioning of the MFE
• A list of edx-platform feature and waffle flags that are either required to enable use of this MFE, or affect the behavior of the MFE in some other way
• A list of IDAs or other MFEs that this MFE depends on to function correctly

Plugins

This MFE can be customized using Frontend Plugin Framework.

The parts of this MFE that can be customized in that manner are documented here.

Getting Help

While this MFE is available for you to use, we are unable to provide support and do not guarantee reviewing and/or merging open-source contributions.

If you have a question or need help, 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/edx/frontend-app-enterprise-checkout/issues

License

The code in this repository is licensed under the AGPLv3 unless otherwise noted.

Please see LICENSE for details.

Contributing

This repository is not currently accepting open-source contributions.

Reporting Security Issues

Please do not report security issues in public. Email security@edx.org instead.