-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor: updated README file to reflect template changes (#860)
* refactor: updated README file to reflect template changes * refactor: Update README.md
- Loading branch information
Showing
1 changed file
with
57 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,14 +2,16 @@ | |
|
||
![Build Status](https://github.com/openedx/frontend-app-learner-portal-enterprise/actions/workflows/ci.yml/badge.svg) | ||
|
||
## Overview | ||
# Purpose | ||
The edX learning platform's frontend for enterprise learners. | ||
|
||
# Getting Started | ||
|
||
## Setup for development | ||
|
||
Ensure you have gone through [Onboarding for devs](https://openedx.atlassian.net/wiki/spaces/ENG/pages/12550298/Developer+Onboarding) | ||
|
||
Clone this repo: `git clone <repo_url>` | ||
Clone this repo: `git clone https://github.com/openedx/frontend-app-learner-portal-enterpise.git` | ||
|
||
Install nodejs (using nvm maybe a good idea to be able to switch node versions and because there is an .nvmrc file that will be usable by nvm) | ||
|
||
|
@@ -212,3 +214,56 @@ TODO/WIP | |
* | ||
* External | ||
* [ReactJS](https://reactjs.org/) | ||
|
||
## 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. | ||
|
||
## 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-learner-portal-enterprise/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]. | ||
|