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

chore: README updated #1396

Merged
merged 1 commit into from
Jun 28, 2024
Merged
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
58 changes: 30 additions & 28 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,25 +1,20 @@
#####################
frontend-app-learning
#####################

|codecov| |license|

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

This is the Learning MFE (micro-frontend application), which renders all
learner-facing course pages (like the course outline, the progress page,
actual course content, etc).

Please tag **@edx/engage-squad** on any PRs or issues. Thanks.

.. |codecov| image:: https://codecov.io/gh/edx/frontend-app-learning/branch/master/graph/badge.svg?token=3z7XvuzTq3
:target: https://codecov.io/gh/edx/frontend-app-learning
.. |license| image:: https://img.shields.io/badge/license-AGPL-informational
:target: https://github.com/openedx/frontend-app-account/blob/master/LICENSE

***************
Getting Started
***************

Expand All @@ -46,32 +41,38 @@ To use this application, `devstack <https://github.com/openedx/devstack>`__ must
Cloning and Startup
===================

.. code-block::
1. Clone your new repo:

.. code-block:: bash

1. Clone your new repo:
git clone https://github.com/openedx/frontend-app-learning.git

``git clone https://github.com/openedx/frontend-app-learning.git``
2. Use node v18.x.

2. Use node v18.x.
The current version of the micro-frontend build scripts supports 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>`_.

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:

3. Install npm dependencies:
.. code-block:: bash

``cd frontend-app-learning && npm ci``
cd frontend-app-learning && npm ci

4. Start the dev server:
4. Start the dev server:

``npm start``
.. code-block:: bash

npm start

Local module development
=========================

To develop locally on modules that are installed into this app, you'll need to create a ``module.config.js``
file (which is git-ignored) that defines where to find your local modules, for instance::
file (which is git-ignored) that defines where to find your local modules, for instance:

.. code-block:: js

module.exports = {
/*
Expand Down Expand Up @@ -107,7 +108,7 @@ This MFE can be customized using `Frontend Plugin Framework <https://github.com/
The parts of this MFE that can be customized in that manner are documented `here </src/plugin-slots>`_.

Environment Variables
======================
=====================

This MFE is configured via environment variables supplied at build time.
All micro-frontends have a shared set of required environment variables,
Expand All @@ -133,7 +134,7 @@ SOCIAL_UTM_MILESTONE_CAMPAIGN

SUPPORT_URL_CALCULATOR_MATH
A link that explains how to use the in-course calculator. You can use the
one in the example below, if you don't want to have your own branded version.
one in the example below if you don't want to have your own branded version.

Example: https://support.edx.org/hc/en-us/articles/360000038428-Entering-math-expressions-in-assignments-or-the-calculator

Expand All @@ -146,7 +147,7 @@ SUPPORT_URL_ID_VERIFICATION

SUPPORT_URL_VERIFIED_CERTIFICATE
A link that explains what a verified certificate is. You can use the
one in the example below, if you don't want to have your own branded version.
one in the example below if you don't want to have your own branded version.
Optional.

Example: https://support.edx.org/hc/en-us/articles/206502008-What-is-a-verified-certificate
Expand All @@ -162,13 +163,13 @@ TWITTER_URL
A link to your Twitter account. The Twitter social-share link won't appear
unless this is set. Optional.

Example: https://twitter.com/edXOnline
Example: https://twitter.com/openedx

Getting Help
===========
============

If you're having trouble, we have discussion forums at
https://discuss.openedx.org where you can connect with others in the community.
If you're having trouble, we have `discussion forums`_
where you can connect with others in the community.

Our real-time conversations are on Slack. You can request a `Slack
invitation`_, then join our `community Slack workspace`_. Because this is a
Expand All @@ -186,17 +187,18 @@ For more information about these options, see the `Getting Help`_ page.
.. _community Slack workspace: https://openedx.slack.com/
.. _#wg-frontend channel: https://openedx.slack.com/archives/C04BM6YC7A6
.. _Getting Help: https://openedx.org/community/connect
.. _discussion forums: https://discuss.openedx.org

Contributing
============

Contributions are very welcome. Please read `How To Contribute`_ for details.
Contributions are very welcome. Please read `How To Contribute`_ for details.

.. _How To Contribute: https://openedx.org/r/how-to-contribute

This project is currently accepting all types of contributions, bug fixes,
security fixes, maintenance work, or new features. However, please make sure
to have a discussion about your new feature idea with the maintainers prior to
to discuss your new feature idea with the maintainers before
beginning development to maximize the chances of your change being accepted.
You can start a conversation by creating a new issue on this repo summarizing
your idea.
Expand Down
Loading