You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.rst
+29-14Lines changed: 29 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,31 +26,46 @@ This is a micro-frontend application responsible for the login, registration and
26
26
Getting Started
27
27
***************
28
28
29
-
Installation
30
-
============
29
+
Prerequisites
30
+
=============
31
31
32
32
`Tutor`_ is currently recommended as a development environment for your new MFE. Please refer to the `relevant tutor-mfe documentation`_ to get started using it.
The default port is 1999. If this does not work for you, update the line
62
+
``PORT=1999`` to your port in all ``.env.*`` files
63
+
64
+
5. Start the devserver. The app will be running at ``localhost:1999``, or whatever port you change it too.
65
+
66
+
.. code-block:: bash
67
+
68
+
npm run dev
54
69
55
70
**Note:** Follow `Enable social auth locally <docs/how_tos/enable_social_auth.rst>`_ for enabling Social Sign-on Buttons (SSO) locally
56
71
@@ -115,7 +130,7 @@ The authentication micro-frontend also requires the following additional variabl
115
130
116
131
* - ``MFE_CONFIG_API_URL``
117
132
- Link of the API to get runtime mfe configuration variables from the site configuration or django settings.
118
-
- ``/api/v1/mfe_config`` | ``''`` (empty strings are falsy)
133
+
- ``/api/v1/mfe_config`` | ``''`` (empty strings are falsy)
119
134
120
135
* - ``APP_ID``
121
136
- Name of MFE, this will be used by the API to get runtime configurations for the specific micro frontend. For a frontend repo `frontend-app-appName`, use `appName` as APP_ID.
@@ -145,7 +160,7 @@ Furthermore, there are several edX-specific environment variables that enable in
145
160
146
161
* - ``SHOW_CONFIGURABLE_EDX_FIELDS``
147
162
- For edX, country and honor code fields are required by default. This flag enables edX specific required fields.
148
-
- ``true`` | ``''`` (empty strings are falsy)
163
+
- ``true`` | ``''`` (empty strings are falsy)
149
164
150
165
For more information see the document: `Micro-frontend applications in Open
0 commit comments