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

[DOCS] Readme updated according OEP-55 #141

Merged
merged 2 commits into from
Jul 7, 2023
Merged

[DOCS] Readme updated according OEP-55 #141

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bdae5fa
docs: readme updated with frontend-template-app readme ref
johnvente Jun 28, 2023
1a1d512
fix: change main branch to master, spelling and getting help url
johnvente Jul 7, 2023
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
142 changes: 119 additions & 23 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,45 +1,48 @@
|Codecov| |license|

.. |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-communications
.. |license| image:: https://img.shields.io/badge/license-AGPL-informational
:target: https://github.com/edx/frontend-app-account/blob/master/LICENSE

frontend-app-communications
==============================
#############################

Please tag **edx-aperture** on any PRs or issues. Thanks!
|license-badge| |status-badge| |ci-badge| |codecov-badge|

Introduction
------------

A tool used by course teams to communicate with thier learners. The interface for anything related to instructor to learner communications. Instructor bulk email, for example.
Purpose
*******

A tool used by course teams to communicate with thier learners. The interface for anything related to instructor to learner communications. Instructor bulk email, for example.
justinhynes marked this conversation as resolved.
Show resolved Hide resolved

Getting started
------------

For now, this repo is not intergrated with devstack. You'll be running the app locally and not through docker. This does make setup a little easier.

1. Clone the repo into your usual workspace
Cloning and Startup
===================

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

mkdir -p ~/workspace/
cd ~/workspace/
git clone https://github.com/edx/frontend-app-communications.git
``git clone https://github.com/edx/frontend-app-communications.git``

2. Install frontend dependencies
2. Use node v18.x.

.. code-block::
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>`_.

npm i
3. Install npm dependencies:

3. Start the devserver. The app will be running at ``localhost:1984``, or whatever port you change it too.
``cd frontend-app-communications && npm install``

.. code-block::
4. Update the application port to use for local development:

Default port is 1984. If this does not work for you, update the line
`PORT=1984` to your port in all .env.* files

5. Start the devserver. The app will be running at ``localhost:1984``, or whatever port you change it too.

.. code-block::

npm start

npm start

Environment Variables/Setup Notes
---------------------------------
Expand All @@ -65,3 +68,96 @@ Tests use `jest` and `react-test-library`. To run all the tests for this repo:
.. code-block::

npm test


**Production Build**

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

Internationalization
====================

Please see refer to the `frontend-platform i18n howto`_ for documentation on
internationalization.

.. _frontend-platform i18n howto: https://github.com/openedx/frontend-platform/blob/master/docs/how_tos/i18n.rst

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-template-application/issues
justinhynes marked this conversation as resolved.
Show resolved Hide resolved

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/getting-help
justinhynes marked this conversation as resolved.
Show resolved Hide resolved

License
*******

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

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

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.

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/

People
******

The assigned maintainers for this component and other project details may be
found in `Backstage`_. Backstage pulls this data from the ``catalog-info.yaml``
file in this repo.

.. _Backstage: https://open-edx-backstage.herokuapp.com/catalog/default/component/frontend-app-communications

Reporting Security Issues
*************************

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

.. |license-badge| image:: https://img.shields.io/github/license/openedx/frontend-app-communications.svg
:target: https://github.com/openedx/frontend-app-communications/blob/main/LICENSE
justinhynes marked this conversation as resolved.
Show resolved Hide resolved
:alt: License

.. |status-badge| image:: https://img.shields.io/badge/Status-Maintained-brightgreen

.. |ci-badge| image:: https://github.com/openedx/frontend-app-communications/actions/workflows/ci.yml/badge.svg
:target: https://github.com/openedx/frontend-app-communications/actions/workflows/ci.yml
:alt: Continuous Integration

.. |codecov-badge| image:: https://codecov.io/github/openedx/frontend-app-communications/coverage.svg?branch=main
:target: https://codecov.io/github/openedx/frontend-app-communications?branch=main
justinhynes marked this conversation as resolved.
Show resolved Hide resolved
:alt: Codecov