Skip to content

Commit

Permalink
refactor: updated README file to reflect template changes
Browse files Browse the repository at this point in the history
  • Loading branch information
mashal-m committed Oct 4, 2023
1 parent 4a74d3e commit 2fbfa48
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -129,16 +129,25 @@ Cloning and Startup
===================

.. code-block::
1. Clone your new repo:
``git clone https://github.com/openedx/frontend-app-account.git``
``git clone https://github.com/openedx/frontend-component-footer.git``
2. Use node v18.x.
The current version of the micro-frontend build scripts support node 18.
Using other major versions of node *may* work, but this is unsupported. For
convenience, this repository includes an .nvmrc file to help in setting the
correct node version via `nvm <https://github.com/nvm-sh/nvm>`_.
3. Install npm dependencies:
``cd frontend-component-footer && npm ci``
4. Start the dev server:
``npm start``
Known Issues
Expand Down

0 comments on commit 2fbfa48

Please sign in to comment.