From a236f5751c2cb547b433fb9a46274de34f018b36 Mon Sep 17 00:00:00 2001 From: mashal-m Date: Thu, 26 Oct 2023 15:58:32 +0500 Subject: [PATCH] refactor: updated README file to reflect template changes --- README.md | 75 +++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 73 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ace280c6..10fac2df 100755 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ +# frontend-app-gradebook + [![Build Status](https://api.travis-ci.com/edx/frontend-app-gradebook.svg?branch=master)](https://travis-ci.com/edx/frontend-app-gradebook) [![Codecov](https://img.shields.io/codecov/c/gh/openedx/frontend-app-gradebook)](https://app.codecov.io/gh/openedx/frontend-app-gradebook) [![npm_version](https://img.shields.io/npm/v/@edx/frontend-app-gradebook.svg)](@edx/frontend-app-gradebook) @@ -5,7 +7,7 @@ [![license](https://img.shields.io/npm/l/@edx/frontend-app-gradebook.svg)](@edx/frontend-app-gradebook) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release) -# Gradebook +# Purpose Gradebook allows course staff to view, filter, and override subsection grades for a course. Additionally for Masters courses, Gradebook enables bulk management of subsection grades. @@ -47,7 +49,8 @@ depending on their needs. Instructors that expect to review grades infrequently to the problem in question will have a worse UX than the legacy gradebook provides. Instructors that rely on the graphs generated by the current gradebook might find the lack of autogenerated graphs to be frustrating. -## Quickstart +## Getting Started + ### Installation @@ -55,6 +58,20 @@ To install gradebook into your project: ``` npm i --save @edx/frontend-app-gradebook ``` +Cloning and Startup +=================== + +1. Clone your new repo: + + ``git clone https://github.com/openedx/frontend-app-gradebook.git`` + +2. Install npm dependencies: + + ``cd frontend-app-gradebook && npm install`` + +3. Start the dev server: + + ``npm start`` ## Running the UI Standalone @@ -119,3 +136,57 @@ running gradebook container. ## Authentication with backend API services See the [`@edx/frontend-auth`](https://github.com/edx-unsupported/frontend-auth) repo for information about securing routes in your application that require user authentication. + +License +======= + +The code in this repository is licensed under the AGPLv3 unless otherwise +noted. + +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-gradebook/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 security@openedx.org.