This repository is a template for Open edX frontend sites. It is flagged as a Template Repository, meaning it can be used as a basis for new GitHub repositories by clicking the green "Use this template" button above.
After copying the template repository, you'll want to do a find-and-replace to
replace all instances of frontend-template-site with the name of your new
repository. Also edit index.html to replace "Template Site" with a friendly
name for this site that users will see in their browser tab.
In the following steps, replace "[PLACEHOLDER]" with the name of the repo you created when copying this template above.
- Clone your new repo:
git clone https://github.com/openedx/frontend-site-[PLACEHOLDER].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-site-[PLACEHOLDER] && npm install
Update the application port to use for local development:
Default port is 8080. If this does not work for you, update the line PORT=8080 to your port in
site.config.dev.tsx.Start the dev server:
npm run dev
The dev server is running at http://apps.local.openedx.io:8080 or whatever port you setup.
Please see refer to the frontend-base i18n howto for documentation on internationalization.
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 security@openedx.org instead.