This repository implements a micro-frontend for Instructor Dashboard, providing a seamless and integrated user experience for instructors. It focuses on providing tools and features specifically designed for instructors to track student progress, and facilitate communication with learners.
### What is the domain of this MFE? - Course information (Enrollment info, Basic course info, Pending tasks) - Membership - Cohorts - Extensions - Student Admin - Data Download - Special Exams - Certificates - Open Responses
After copying the template repository, you'll want to do a find-and-replace to
replace all instances of frontend-app-instruct with the name of
your new repository. Also edit index.html to replace "Application Template"
with a friendly name for this application that users will see in their browser
tab.
Tutor is recommended as the development environment for your new frontend app. 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-instruct.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-instruct && 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.
The source for this project is organized into nested submodules according to the Feature-based Application Organization ADR.
Please see refer to the frontend-base 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-instruct/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 security@openedx.org instead.