Skip to content

A site for public browsing of enterprise catalogs, also called the Explore Catalog

License

Notifications You must be signed in to change notification settings

openedx/frontend-app-enterprise-public-catalog

Build Status Codecov license

frontend-app-enterprise-public-catalog

Introduction

This application is a public facing catalog page for use by edX consumers to find courses in catalogs before deciding to enroll.

The dev server is running at http://localhost:8735. The staging server is running at https://explore-catalog.stage.edx.org/.

Project Structure

The source for this project is organized into nested submodules according to the ADR Feature-based Application Organization.

Build Process Notes

Local Development

To run this project locally:

  1. Clone this repository

  2. From repository root folder, run:

    npm install

    Note: locally this app will default to open edX branding, so colors and formatting might look a little different than what will be deployed. To combat this, you can optionally run:

    npm install --save @edx/brand@npm:@edx/brand-edx.org

  3. This project requires Algolia developer keys. Once you have them, make the following local modifications to the .env.development file and replace the keys:

    ALGOLIA_APP_ID=''
    ALGOLIA_SEARCH_API_KEY=''
    ALGOLIA_INDEX_NAME=''
    
  4. You will also need to replace the following variables with valid Catalog Query Titles that are present in your Algolia index:

    EDX_FOR_SUBSCRIPTION_TITLE='' # default = 'Subscription'
    EDX_ENTERPRISE_ALACARTE_TITLE='' # default = 'A la carte'
    
  5. From repository root folder, run:

    npm start

    to start your local server at http://localhost:8735.

Helpful Testing Commands

  • npm run tests
  • npm run lint
  • npm run lint:fix to automatically fix errors

Production Build

The production build is created with npm run build.

Internationalization

Please see edx/frontend-platform's i18n module for documentation on internationalization. The documentation explains how to use it, and the How To has more detail.

About

A site for public browsing of enterprise catalogs, also called the Explore Catalog

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages