Skip to content
This repository has been archived by the owner on Nov 4, 2024. It is now read-only.

refactor: updated README file to reflect template changes #347

Closed
Closed
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
82 changes: 73 additions & 9 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,17 +1,23 @@
|Build Status| |Codecov| |npm_version| |npm_downloads| |license| |semantic-release|

######################
frontend-app-ecommerce
======================
######################

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

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

Introduction
------------
********
Purpose
********

This is a micro-frontend application responsible for the display of an authenticated user's single purchase order history and subscription history. Additional work has been done and is in-progress to enable receipt pages in this application, currently hosted in ecommerce.

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

Installation
------------
============

This MFE is bundled with `Devstack <https://github.com/openedx/devstack>`_, see the `Getting Started <https://github.com/openedx/devstack#getting-started>`_ section for setup instructions.

Expand All @@ -35,7 +41,7 @@ This MFE is bundled with `Devstack <https://github.com/openedx/devstack>`_, see
.. image:: ./docs/images/localhost_preview.png

Environment Variables/Setup Notes
---------------------------------
=================================

This MFE is configured via environment variables supplied at build time. All micro-frontends have a shared set of required environment variables, as documented in the Open edX Developer Guide under `Required Environment Variables <https://edx.readthedocs.io/projects/edx-developer-docs/en/latest/developers_guide/micro_frontends_in_open_edx.html#required-environment-variables>`__.

Expand All @@ -46,17 +52,75 @@ To have ecommerce send users to this receipt page (instead of its own), there ar
This micro-frontend has no additional required environment variables.

Known Issues
------------
============

None

License
=======

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

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

Development Roadmap
-------------------
===================

This MFE is currently in maintenance mode, as we have no further development planned for it. However, if we want to pull more ecommerce interfaces out into a micro-frontend, this would be where they should live. Note that `frontend-app-payment <https://github.com/openedx/frontend-app-payment>`_ contains the checkout flow.

Anyone merging to this repository is expected to `release and monitor their changes <https://openedx.atlassian.net/wiki/spaces/RS/pages/1835106870/How+to+contribute+to+our+repositories>`__; if you are not able to do this DO NOT MERGE, please coordinate with someone who can to ensure that the changes are released.

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

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
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.

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.

Our real-time conversations are on Slack. You can request a `Slack
invitation`_, then join our `community Slack workspace`_. Because this is a
frontend repository, the best place to discuss it would be in the `#wg-frontend
channel`_.

For anything non-trivial, the best path is to open an issue in this repository
with as many details about the issue you are facing as you can provide.

https://github.com/openedx/frontend-app-ecommerce/issues

For more information about these options, see the `Getting Help`_ page.

.. _Slack invitation: https://openedx.org/slack
.. _community Slack workspace: https://openedx.slack.com/
.. _#wg-frontend channel: https://openedx.slack.com/archives/C04BM6YC7A6
.. _Getting Help: https://openedx.org/community/connect

The Open edX Code of Conduct
============================

All community members are expected to follow the `Open edX Code of Conduct`_.

.. _Open edX Code of Conduct: https://openedx.org/code-of-conduct/


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

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

==============================

.. |Build Status| image:: https://api.travis-ci.org/edx/frontend-app-ecommerce.svg?branch=master
Expand Down
Loading