@@ -42,91 +42,25 @@ by the new Fantastico storage engine.
4242Getting Started
4343===============
4444
45- Devstack Installation
46- ---------------------
45+ Prerequisites
46+ =============
47+
48+ The Tutor _ platform is a prerequisite for developing an MFE.
49+ Utilize `relevant tutor-mfe documentation `_ to guide you through
50+ the process of MFE development within the Tutor environment.
51+
52+ .. _Tutor : https://github.com/overhangio/tutor
53+
54+ .. _relevant tutor-mfe documentation : https://github.com/overhangio/tutor-mfe#mfe-development
4755
4856.. note ::
4957
5058 [TODO]
5159
5260 Describe in detail how this MFE can be installed and set up for development
53- in a devstack . Include as many screenshots as you can to make your guide
61+ with tutor . Include as many screenshots as you can to make your guide
5462 easier to follow! Use the following steps as an example:
5563
56- Follow these steps to provision, run, and enable an instance of the
57- [PLACEHOLDER] MFE for local development via the `devstack `_.
58-
59- .. _devstack : https://github.com/openedx/devstack#getting-started
60-
61- #. To start, clone the devstack repository as a child of an arbitrary ``~/workspace/ `` directory.
62-
63- .. code-block ::
64-
65- mkdir -p ~/workspace/
66- cd ~/workspace/
67- git clone https://github.com/openedx/devstack.git
68-
69- #. Configure default services and setup devstack
70-
71- Create a ``devstack/options.local.mk `` file with only the services required.
72- Commonly, this will just be the LMS:
73-
74- .. code-block ::
75-
76- DEFAULT_SERVICES ?= \
77- lms
78-
79- #. Start the devstack with:
80-
81- .. code-block ::
82-
83- cd devstack
84- make dev.pull
85- make dev.provision
86- make dev.up
87-
88- #. In an LMS shell, enable the ``ENABLE_[PLACEHOLDER]_MICROFRONTEND `` feature flag:
89-
90- .. code-block ::
91-
92- make lms-shell
93- vim /edx/etc/lms.yml
94- ---
95- FEATURES:
96- ENABLE_[PLACEHOLDER]_MICROFRONTEND: true
97-
98- Exit the shell and restart the LMS so changes take effect:
99-
100- .. code-block ::
101-
102- make lms-restart
103-
104- #. Create and enable the waffle flag required to redirect users to the MFE,
105- enabling it for everyone:
106-
107- .. code-block ::
108-
109- make lms-shell
110- ./manage.py lms waffle_flag --create --everyone [PLACEHOLDER].redirect_to_microfrontend
111-
112- #. Start this MFE with:
113-
114- .. code-block ::
115-
116- cd frontend-app-[PLACEHOLDER]
117- nvm use
118- npm ci
119- npm start
120-
121- #. Finally, open the MFE in a browser
122-
123- Navigate to `http://localhost:8080 <http://localhost:8080 >`_ to open the
124- MFE. This is what it should look like if everything worked:
125-
126- .. figure :: ./docs/images/template.jpg
127-
128- "Polycon marking template" by mangtronix is licensed under CC BY-SA 2.0.
129-
13064Configuration
13165-------------
13266
0 commit comments