This repository contains a series of support tools for the OpenedX platform.
Devstack.
If you start Devstack with make dev.up
that should give you everything you need as a companion to this frontend.
- Clone your new repo:
git clone <Repo URL above>
- Install npm dependencies:
cd frontend-app-support-tools && npm install
- Start the dev server:
npm start
The dev server is running at http://localhost:18450.
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.
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-support-tools/issues
For more information about these options, see the Getting Help page.
All community members are expected to follow the Open edX Code of Conduct.
The source for this project is organized into nested submodules according to the ADR Feature-based Application Organization.
The production build is created with npm run build
.
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.