-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor: updated README file to reflect template changes (#481)
* refactor: updated README file to reflect template changes * refactor: remove edx code of conduct portion
- Loading branch information
Showing
1 changed file
with
47 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,26 +1,70 @@ | ||
############################# | ||
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 | ||
=================== | ||
|
||
.. code-block:: | ||
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';`` | ||
|
||
Development | ||
----------- | ||
=========== | ||
|
||
- Install requirements `npm install` | ||
- Install peer dependencies `npm install @edx/frontend-analytics @edx/frontend-base @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 <LICENSE>`_ for details. | ||
|
||
Reporting Security Issues | ||
========================= | ||
|
||
Please do not report security issues in public. Please email [email protected]. | ||
|
||
|
||
.. |npm_version| image:: https://img.shields.io/npm/v/@edx/frontend-component-header-edx.svg | ||
:target: https://www.npmjs.com/package/@edx/frontend-component-header-edx | ||
.. |npm_downloads| image:: https://img.shields.io/npm/dt/@edx/frontend-component-header-edx.svg | ||
|