Skip to content

Commit 76f735e

Browse files
Mashal-mMashal-m
authored
refactor: updated README file to reflect template changes (#380)
* refactor: update README File * refactor: update README file * refactor: update readMe file * refactor: update readMe file * refactor: update readMe file * refactor: update readMe file * refactor: update readMe file * refactor: update readMe file * refactor: update readMe file * refactor: update readMe file * refactor: update readMe file * refactor: update readMe file * refactor: update readMe file * refactor: update readMe file * refactor: update readMe file * refactor: update readMe file * refactor: update readMe file * refactor: replace npm install with npm ci
1 parent 2298791 commit 76f735e

File tree

1 file changed

+110
-12
lines changed

1 file changed

+110
-12
lines changed

‎README.rst

Lines changed: 110 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,42 @@
22
frontend-component-header
33
#########################
44

5-
|Build Status| |Codecov| |npm_version| |npm_downloads| |license| |semantic-release|
5+
|license| |Build Status| |Codecov| |npm_version| |npm_downloads| |semantic-release|
66

77
********
8-
Overview
8+
Purpose
99
********
1010

1111
A generic header for Open edX micro-frontend applications.
1212

1313
************
14-
Requirements
14+
Getting Started
1515
************
1616

17+
Prerequisites
18+
=============
19+
20+
The `devstack`_ is currently recommended as a development environment for your
21+
new MFE. If you start it with ``make dev.up.lms`` that should give you
22+
everything you need as a companion to this frontend.
23+
24+
Note that it is also possible to use `Tutor`_ to develop an MFE. You can refer
25+
to the `relevant tutor-mfe documentation`_ to get started using it.
26+
27+
.. _Devstack: https://github.com/openedx/devstack
28+
29+
.. _Tutor: https://github.com/overhangio/tutor
30+
31+
.. _relevant tutor-mfe documentation: https://github.com/overhangio/tutor-mfe#mfe-development
32+
33+
Requirements
34+
============
35+
1736
This component uses ``@edx/frontend-platform`` services such as i18n, analytics, configuration, and the ``AppContext`` React component, and expects that it has been loaded into a micro-frontend that has been properly initialized via ``@edx/frontend-platform``'s ``initialize`` function. `Please visit the frontend template application to see an example. <https://github.com/openedx/frontend-template-application/blob/master/src/index.jsx>`_
1837

38+
1939
Environment Variables
20-
=====================
40+
====================
2141

2242
* ``LMS_BASE_URL`` - The URL of the LMS of your Open edX instance.
2343
* ``LOGOUT_URL`` - The URL of the API endpoint which performs a user logout.
@@ -32,19 +52,42 @@ Environment Variables
3252
menu items when truthy. This is intended to be used in micro-frontends like
3353
frontend-app-authentication in which these menus are considered distractions from the user's task.
3454

35-
************
3655
Installation
37-
************
56+
============
3857

3958
To install this header into your Open edX micro-frontend, run the following command in your MFE:
4059

4160
``npm i --save @edx/frontend-component-header``
4261

4362
This will make the component available to be imported into your application.
4463

45-
*****
64+
Cloning and Startup
65+
===================
66+
67+
.. code-block::
68+
69+
70+
1. Clone your new repo:
71+
72+
``git clone https://github.com/openedx/frontend-component-header.git``
73+
74+
2. Use node v18.x.
75+
76+
The current version of the micro-frontend build scripts support node 18.
77+
Using other major versions of node *may* work, but this is unsupported. For
78+
convenience, this repository includes an .nvmrc file to help in setting the
79+
correct node version via `nvm <https://github.com/nvm-sh/nvm>`_.
80+
81+
3. Install npm dependencies:
82+
83+
``cd frontend-component-header && npm ci``
84+
85+
4. Start the dev server:
86+
87+
``npm start``
88+
4689
Usage
47-
*****
90+
=====
4891

4992
This library has the following exports:
5093

@@ -58,10 +101,8 @@ Examples
58101
* `An example of component and messages usage. <https://github.com/openedx/frontend-template-application/blob/3355bb3a96232390e9056f35b06ffa8f105ed7ca/src/index.jsx#L21>`_
59102
* `An example of SCSS file usage. <https://github.com/openedx/frontend-template-application/blob/3cd5485bf387b8c479baf6b02bf59e3061dc3465/src/index.scss#L8>`_
60103

61-
62-
***********
63104
Development
64-
***********
105+
===========
65106

66107
Install dependencies::
67108

@@ -75,6 +116,63 @@ Build a production distribution::
75116

76117
npm run build
77118

119+
License
120+
=======
121+
122+
The code in this repository is licensed under the AGPLv3 unless otherwise
123+
noted.
124+
125+
Please see `LICENSE <LICENSE>`_ for details.
126+
127+
Contributing
128+
============
129+
130+
Contributions are very welcome. Please read `How To Contribute`_ for details.
131+
132+
.. _How To Contribute: https://openedx.org/r/how-to-contribute
133+
134+
This project is currently accepting all types of contributions, bug fixes,
135+
security fixes, maintenance work, or new features. However, please make sure
136+
to have a discussion about your new feature idea with the maintainers prior to
137+
beginning development to maximize the chances of your change being accepted.
138+
You can start a conversation by creating a new issue on this repo summarizing
139+
your idea.
140+
141+
Getting Help
142+
===========
143+
144+
If you're having trouble, we have discussion forums at
145+
https://discuss.openedx.org where you can connect with others in the community.
146+
147+
Our real-time conversations are on Slack. You can request a `Slack
148+
invitation`_, then join our `community Slack workspace`_. Because this is a
149+
frontend repository, the best place to discuss it would be in the `#wg-frontend
150+
channel`_.
151+
152+
For anything non-trivial, the best path is to open an issue in this repository
153+
with as many details about the issue you are facing as you can provide.
154+
155+
https://github.com/openedx/frontend-component-header/issues
156+
157+
For more information about these options, see the `Getting Help`_ page.
158+
159+
.. _Slack invitation: https://openedx.org/slack
160+
.. _community Slack workspace: https://openedx.slack.com/
161+
.. _#wg-frontend channel: https://openedx.slack.com/archives/C04BM6YC7A6
162+
.. _Getting Help: https://openedx.org/community/connect
163+
164+
The Open edX Code of Conduct
165+
============================
166+
167+
All community members are expected to follow the `Open edX Code of Conduct`_.
168+
169+
.. _Open edX Code of Conduct: https://openedx.org/code-of-conduct/
170+
171+
Reporting Security Issues
172+
=========================
173+
174+
Please do not report security issues in public. Please email [email protected].
175+
78176
.. |Build Status| image:: https://api.travis-ci.com/edx/frontend-component-header.svg?branch=master
79177
:target: https://travis-ci.com/edx/frontend-component-header
80178
.. |Codecov| image:: https://img.shields.io/codecov/c/github/edx/frontend-component-header
@@ -86,4 +184,4 @@ Build a production distribution::
86184
.. |license| image:: https://img.shields.io/npm/l/@edx/frontend-component-header.svg
87185
:target: @edx/frontend-component-header
88186
.. |semantic-release| image:: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
89-
:target: https://github.com/semantic-release/semantic-release
187+
:target: https://github.com/semantic-release/semantic-release

0 commit comments

Comments
 (0)