This is the Catalog micro-frontend application, currently under development.
What is the domain of this MFE?
- Home / Index page
- Course About page
- Course Catalog page
These are public-facing pages intended for unauthenticated users.
The goal is to replace legacy views in edx-platform with modern, React and Paragon-based implementations.
The Tutor platform is a prerequisite for developing an MFE. Utilize relevant tutor-mfe documentation to guide you through the process of MFE development within the Tutor environment.
- Clone the repo:
git clone https://github.com/openedx/frontend-app-catalog.git
- Use node v20.x.
The current version of the micro-frontend build scripts support node 20. Using other major versions of node may work, but this is unsupported. For convenience, this repository includes an .nvmrc file to help in setting the correct node version via nvm.
- Install npm dependencies:
cd frontend-app-catalog && npm ci
- Mount the frontend-app-catalog MFE in Tutor:
tutor mounts add <your-tutor-project-dir>/frontend-app-catalog
- Build the Docker image:
tutor images build catalog-dev
- Launch the development server with Tutor:
tutor dev start catalog
The dev server is running at http://apps.local.openedx.io:1998/catalog/.
Tutor. If you start Tutor with tutor dev start catalog
that should give you everything you need as a companion to this frontend.
Please see refer to the frontend-platform i18n howto for documentation on internationalization.
If you're having trouble, we have discussion forums at https://discuss.openedx.org where you can connect with others in the community.
Our real-time conversations are on Slack. You can request a Slack invitation, then join our community Slack workspace. Because this is a frontend repository, the best place to discuss it would be in the #wg-frontend channel.
For anything non-trivial, 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/openedx/frontend-app-catalog/issues
For more information about these options, see the Getting Help page.
The code in this repository is licensed under the AGPLv3 unless otherwise noted.
Please see LICENSE for details.
Contributions are very welcome. Please read How To Contribute for details.
This project is currently accepting all types of contributions, bug fixes, security fixes, maintenance work, or new features. However, please make sure to have a discussion about your new feature idea with the maintainers prior to beginning development to maximize the chances of your change being accepted. You can start a conversation by creating a new issue on this repo summarizing your idea.
All community members are expected to follow the Open edX Code of Conduct.
The assigned maintainers for this component and other project details may be
found in Backstage. Backstage pulls this data from the catalog-info.yaml
file in this repo.
Please do not report security issues in public, and email [email protected] instead.