Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: updated README file to reflect template changes #334

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 63 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,14 +1,35 @@
#############################
frontend-component-footer-edx
=============================
#############################

|Build Status| |npm_version| |npm_downloads| |license|
|semantic-release|

********
Purpose
********

frontend-component-footer-edx is a library containing a site footer
component for use when building edX frontend applications.

Prerequisites
=============

The `devstack`_ is currently recommended as a development environment for your
new MFE. If you start it with ``make dev.up.lms`` that should give you
everything you need as a companion to this frontend.

Note that it is also possible to use `Tutor`_ to develop an MFE. You can refer
to the `relevant tutor-mfe documentation`_ to get started using it.

.. _Devstack: https://github.com/openedx/devstack

.. _Tutor: https://github.com/overhangio/tutor

.. _relevant tutor-mfe documentation: https://github.com/overhangio/tutor-mfe#mfe-development

Usage
-----
=====

To install frontend-component-footer-edx into your project::

Expand All @@ -32,13 +53,38 @@ Component Usage::
- onLanguageSelected (optional)
- supportedLanguages (optional)

Cloning and Startup
===================

.. code-block::


1. Clone your new repo:

``git clone https://github.com/openedx/frontend-component-footer-edx.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-edx && npm ci``

4. Start the dev server:

``npm start``

Requirements
------------
============

This component uses ``@edx/frontend-i18n``. Any containing app must provide ``@edx/frontend-i18n`` as a peer dependency, and be wrapped inside an ``IntlProvider`` element, whether or not your consuming application is actually localized. For a basic default locale (English) version, follow the ``IntlProvider`` example in the sample application in `src/index.jsx <src/index.jsx>`__.

Development
-----------
===========

Start the dev server::

Expand All @@ -48,6 +94,19 @@ Build the component::

npm run build

License
=======

The code in this repository is licensed under the AGPLv3 unless otherwise
noted.

Please see `LICENSE <LICENSE>`_ for details.

Reporting Security Issues
=========================

Please do not report security issues in public. Please email [email protected].

.. |Build Status| image:: https://api.travis-ci.com/edx/frontend-component-footer-edx.svg?branch=master
:target: https://travis-ci.com/edx/frontend-component-footer-edx
.. |npm_version| image:: https://img.shields.io/npm/v/@edx/frontend-component-footer-edx.svg
Expand Down