A MFE application which is intended to be used by tutor.

This project requires the following tools to be installed:

1. Clone your new repo:

git clone https://github.com/S1mpleOW/frontend-app-tutor.git

2. Use node v18.x.

   The current version of the micro-frontend build scripts support node 18. 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.

3. Install npm dependencies:

cd frontend-app-tutor && npm install

4. 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 all .env.* files

5. Start the dev server:

npm start

The dev server is running at http://localhost:8080 or whatever port you setup.

This section concerns development of frontend-template-application itself, not the templated copy.

It should be noted that one of the goals of this repository is for it to function correctly as an MFE (as in npm install && npm start) even if no modifications are made. This ensures that developers get a practical working example, not just a theoretical one.

This also means, of course, that any committed code should be tested and subject to both CI and branch protection rules.

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.