Skip to content

Commit 11b5530

Browse files
committed
docs: Update doc formatting.
1 parent fb58f43 commit 11b5530

File tree

1 file changed

+20
-10
lines changed

1 file changed

+20
-10
lines changed

README.md

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ provide examples for the various different plugin interfaces in the Open edX
55
platform.
66

77
The `frontend` folder makes use of the frontend-plugin-framework and slots to
8-
add new components and functionality to multiple open edx frotends.
8+
add new components and functionality to multiple open edx frontends.
99

1010
The `backend` folder will contain a python django app that can that can be
1111
installed alongside edx-platform and makes use of the events and filters
@@ -17,7 +17,7 @@ backend and frontend plugins in a deployment of tutor.
1717
# Local Development for the Frontend Plugin w/Tutor
1818

1919
When developing with tutor, it's useful to use tutor to start up the rest of
20-
the stack and then startup the specific MFE you want to develop on your local
20+
the stack and then run the specific MFE you want to develop on your local
2121
machine. We just need to tell tutor to not start the specific MFE as a part of
2222
the tutor-mfe plugin.
2323

@@ -26,14 +26,21 @@ the tutor-mfe plugin.
2626
# Tell tutor to start this MFE in dev mode
2727
tutor mounts add ~/src/openedx/frontend-app-learner-dashboard
2828
tutor dev start learner-dashbard
29+
# Update all the settings and start up everything
2930
tutor dev launch
31+
tutor dev stop
32+
tutor dev start lms cms mfe
33+
```
3034

31-
# Go to the `learner-dashboard` MFE folder locally.
35+
## Go to the `learner-dashboard` MFE folder locally.
36+
```
3237
npm install /path/to/sample-plugin/frontend
38+
```
39+
40+
## Add an env.config.jsx
41+
This file is not checked in and imports and injects your plugin for local
42+
development.
3343

34-
# Add an env.config.jsx
35-
# This file is not checked in and imports and injects your plugin for local
36-
# development.
3744
```
3845
import { DIRECT_PLUGIN, PLUGIN_OPERATIONS } from '@openedx/frontend-plugin-framework';
3946
import { CourseList } from '@feanil/sample-plugin';
@@ -60,12 +67,15 @@ const config = {
6067
},
6168
},
6269
}
63-
```
70+
6471
export default config;
72+
```
73+
74+
## Add a module.config.js
75+
76+
This file tells webpack to use your local repo for the code of the module rather
77+
than the `npm install` version of your package.
6578

66-
# Add a module.config.js
67-
# This file tells webpack to use your local repo for the code of the module
68-
# rather than the `npm install` version of your package.
6979
```
7080
module.exports = {
7181
/*

0 commit comments

Comments
 (0)