This repository is a React-based micro frontend for the Open edX discussion forums.
The devstack is currently recommended as a development environment for your
new MFE. If you start it with make dev.up.lms that should give you
everything you need as a companion to this frontend.
Note that it is also possible to use Tutor to develop an MFE. You can refer to the relevant tutor-mfe documentation to get started using it.
- Clone your new repo:
git clone https://github.com/openedx/frontend-app-discussions.git
- Install npm dependencies:
cd frontend-app-discussions && npm install
- Start the dev server:
npm start
The dev server is running at http://localhost:2002.
This MFE can be customized using Frontend Plugin Framework.
The parts of this MFE that can be customized in that manner are documented here.
Please tag **@openedx/edx-infinity ** on any PRs or issues. Thanks.
If you're having trouble, we have discussion forums at https://discuss.openedx.org where you can connect with others in the community. 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-discussions/issues
For more information about these options, see the Getting Help page.
Details about how to become a contributor to the Open edX project may be found in the wiki at How to contribute
PR description template should be automatically applied if you are sending PR from github interface; otherwise you can find it it at PULL_REQUEST_TEMPLATE.md
This project is currently accepting all types of contributions, bug fixes and security fixes
All community members should familiarize themselves with the Open edX Code of Conduct.
The assigned maintainers for this component and other project details may be found in Backstage or from inspecting catalog-info.yaml.
Please do not report security issues in public. Please email security@openedx.org.
The source for this project is organized into nested submodules according to the ADR Feature-based Application Organization.
Production Build
The production build is created with npm run build.
The code in this repository is licensed under the AGPLv3 unless otherwise noted.
Please see LICENSE for details.
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.
Please do not report security issues in public. Please email security@openedx.org.