I would like to get help. What happens is that I want to make a modification to the frontend-app-learning. I already cloned the repository on my machine, but now I want to know how I can make the settings I saved locally look. For example, I want my local to point to the cloned file instead of GitHub. I already tried, but now it shows me package errors. I already installed it in my mounts list. Could someone help me know how I can modify the frontend and how it works?
Hi @Edwin75206 and welcome to the community!
Have you searched the forums and tutor docs? What have you tried that isn’t working? What version of Tutor are you running?
GitHub - overhangio/tutor-mfe: This plugin makes it possible to easily add micro frontend (MFE) applications on top of an Open edX platform that runs with Tutor. and these are the Tutor docs: Getting started — Tutor documentation
Hi @sarina , that’s exactly the one I’ve used. I’ve downloaded the GitHub repo of frontend-app-learning, and the Tutor version I’m using is 19.0.2. I think I’m also a bit confused about how to make the changes work. For example, I already have the GitHub version of frontend-app-learning in my Tutor setup, and I’ve made some changes. Now, how can I make those changes show up in production? How can I make Tutor stop pointing to the online GitHub repositories and instead point to my local modified version that I’ve already downloaded? Do you know how I could do that?
@tutor-maintainers is there documentation that can answer this question? If not, could we get an answer and figure out the right place to document this?
You need to re-build the “mfe” Docker image with your changes, and then deploy it to production – exactly how depends on whether you are running tutor local or tutor k8s, whether you are building remotely or locally, etc.
This should be documented here: GitHub - overhangio/tutor-mfe: This plugin makes it possible to easily add micro frontend (MFE) applications on top of an Open edX platform that runs with Tutor. Documentation can always be improved. But at this point I’d rather spend my time fixing the MFE build process. The tutor-mfe plugin can only do so much, and can’t make up for the deficiencies of the microfrontend architecture.
@regis @arbrandes I am so happy to help improve the documentation but I’m not sure where to put the instructions. Would it be in this section: https://github.com/overhangio/tutor-mfe/?tab=readme-ov-file#mfe-development? Where it says “in production the image will be rebuilt automatically during tutor dev launch”?
Yes, I believe this would qualify as an improvement to the “MFE Development” section of the tutor-mfe README. Perhaps as a subsection of its own (“Deploying Changes to Production”?), since this is a question we get often.
Provided the modified codebase is mounted in the same machine where production deployment happens, it’s a matter of running tutor images build mfe and restarting your local deployment via tutor local stop && tutor local start -d.
But as RĂ©gis says, if the production deployment is on a different machine, or if using K8S, getting the image there will depend on the topology of the setup.
@arbrandes I made a PR here for review: Add section on deploying MFE changes to production by sarina · Pull Request #251 · overhangio/tutor-mfe · GitHub
1 Like
If I have the Tutor Indigo theme activated and installed, could that possibly cause issues when loading the MFEs I’ve modified on GitHub?