Skip to content

Commit 063bf75

Browse files
AntonOfTheWoodsarbrandes
authored andcommitted
docs: include 'standard' dev instructions
1 parent b54ad18 commit 063bf75

1 file changed

Lines changed: 29 additions & 14 deletions

File tree

README.rst

Lines changed: 29 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -26,31 +26,46 @@ This is a micro-frontend application responsible for the login, registration and
2626
Getting Started
2727
***************
2828

29-
Installation
30-
============
29+
Prerequisites
30+
=============
3131

3232
`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.
3333

3434
.. _Tutor: https://github.com/overhangio/tutor
3535
.. _relevant tutor-mfe documentation: https://github.com/overhangio/tutor-mfe?tab=readme-ov-file#mfe-development
3636

37-
Devstack (Deprecated) instructions
38-
==================================
37+
Cloning and Startup
38+
===================
39+
40+
1. Clone your new repo:
41+
42+
.. code-block:: bash
43+
44+
git clone https://github.com/edx/frontend-app-authn.git
3945
40-
1. Install Devstack using the `Getting Started <https://github.com/openedx/devstack#getting-started>`_ instructions.
46+
2. Use the version of Node specified in the ``.nvmrc`` file.
4147

42-
2. Start up LMS, if it's not already started.
48+
The current version of the micro-frontend build scripts supports the version of Node found in ``.nvmrc``.
49+
Using other major versions of node *may* work, but this is unsupported. For
50+
convenience, this repository includes a ``.nvmrc`` file to help in setting the
51+
correct node version via `nvm <https://github.com/nvm-sh/nvm>`_.
4352

44-
4. Within this project (frontend-app-authn), install requirements and start the development server:
53+
3. Install npm dependencies:
4554

46-
.. code-block::
55+
.. code-block:: bash
4756
48-
npm install
49-
npm start # The server will run on port 1999
57+
cd frontend-app-authn && npm install
5058
51-
5. Once the dev server is up, visit http://localhost:1999 to access the MFE
59+
4. Update the application port to use for local development:
5260

53-
.. image:: ./docs/images/frontend-app-authn-localhost-preview.png
61+
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
5469
5570
**Note:** Follow `Enable social auth locally <docs/how_tos/enable_social_auth.rst>`_ for enabling Social Sign-on Buttons (SSO) locally
5671

@@ -115,7 +130,7 @@ The authentication micro-frontend also requires the following additional variabl
115130

116131
* - ``MFE_CONFIG_API_URL``
117132
- 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)
119134

120135
* - ``APP_ID``
121136
- 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
145160

146161
* - ``SHOW_CONFIGURABLE_EDX_FIELDS``
147162
- 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)
149164

150165
For more information see the document: `Micro-frontend applications in Open
151166
edX <https://github.com/overhangio/tutor-mfe?tab=readme-ov-file#mfe-development>`__.

0 commit comments

Comments
 (0)