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.

Sign up for GitHub

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

Jump to bottom

refactor: updated README file to reflect template changes #367

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

refactor: updated README file to reflect template changes #367

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
56 changes: 47 additions & 9 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,29 +1,51 @@
######################################
frontend-app-enterprise-public-catalog
######################################

|Build Status| |Codecov| |license|

frontend-app-enterprise-public-catalog
======================================

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

This application is a public facing catalog page for use by edX consumers to find courses in catalogs before deciding to enroll.

The dev server is running at `http://localhost:8735 <http://localhost:8735>`_.
The staging server is running at `https://explore-catalog.stage.edx.org/ <https://explore-catalog.stage.edx.org/>`_.
***************
Getting Started
***************

Prerequisites
=============

The `devstack`_ is currently recommended as a development environment for your
new MFE. If you start it with ``make dev.up.lms`` that should give you
everything you need as a companion to this frontend.

Note that it is also possible to use `Tutor`_ to develop an MFE. You can refer
to the `relevant tutor-mfe documentation`_ to get started using it.

.. _Devstack: https://github.com/openedx/devstack

.. _Tutor: https://github.com/overhangio/tutor

.. _relevant tutor-mfe documentation: https://github.com/overhangio/tutor-mfe#mfe-development

Project Structure
-----------------
=================

The source for this project is organized into nested submodules according to the ADR `Feature-based Application Organization <https://github.com/openedx/frontend-app-enterprise-public-catalog/blob/master/docs/decisions/0002-feature-based-application-organization.rst>`_.

Build Process Notes
-------------------
===================
**Local Development**

To run this project locally:

1. Clone this repository

``git clone https://github.com/openedx/frontend-app-enterprise-public-catalog.git``

2. From repository root folder, run:

``npm install``
Expand Down Expand Up @@ -53,6 +75,9 @@ To run this project locally:

to start your local server at `http://localhost:8735 <http://localhost:8735>`_.

The dev server is running at `http://localhost:8735 <http://localhost:8735>`_.
The staging server is running at `https://explore-catalog.stage.edx.org/ <https://explore-catalog.stage.edx.org/>`_.

**Helpful Testing Commands**

* ``npm run tests``
Expand All @@ -63,11 +88,24 @@ To run this project locally:

The production build is created with ``npm run build``.

License
=======

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

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

Internationalization
--------------------
====================

Please see `edx/frontend-platform's i18n module <https://edx.github.io/frontend-platform/module-Internationalization.html>`_ for documentation on internationalization. The documentation explains how to use it, and the `How To <https://github.com/openedx/frontend-i18n/blob/master/docs/how_tos/i18n.rst>`_ has more detail.

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

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

.. |Build Status| image:: https://api.travis-ci.com/edx/frontend-app-enterprise-public-catalog.svg?branch=master
:target: https://travis-ci.com/edx/frontend-app-enterprise-public-catalog
.. |Codecov| image:: https://codecov.io/gh/edx/frontend-app-enterprise-public-catalog/branch/master/graph/badge.svg
Expand Down
Loading