Skip to content

Latest commit

 

History

History
79 lines (51 loc) · 2.3 KB

README.rst

File metadata and controls

79 lines (51 loc) · 2.3 KB
Raw

frontend-component-header-edx

npm_version npm_downloads license

Purpose

This is the standard edX header for use in React applications. It has two exports:

  • default: The Header Component
  • messages: for i18n in the form of { locale: { key: translatedString } }

Cloning and Startup

1. Clone your new repo:

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

4. Start the dev server:

  ``npm start``

Usage

import Header, { messages } from '@edx/frontend-component-header-edx';

Plugins

This component can be customized using Frontend Plugin Framework.

The parts of this component that can be customized in that manner are documented here.

Development

  • Install requirements npm install
  • Install peer dependencies npm install @edx/frontend-analytics @edx/frontend-platform @edx/frontend-i18n prop-types react
  • Start the example server npm start
  • Visit http://localhost:1234

License

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

Please see LICENSE for details.

Reporting Security Issues

Please do not report security issues in public. Please email security@openedx.org.