{"id":20037845,"url":"https://github.com/openedx/frontend-app-gradebook","last_synced_at":"2025-04-07T09:18:25.674Z","repository":{"id":37388978,"uuid":"153483450","full_name":"openedx/frontend-app-gradebook","owner":"openedx","description":"Instructor grade book tool","archived":false,"fork":false,"pushed_at":"2025-03-21T17:54:09.000Z","size":9715,"stargazers_count":11,"open_issues_count":20,"forks_count":93,"subscribers_count":70,"default_branch":"master","last_synced_at":"2025-03-21T18:03:11.792Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/openedx.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-10-17T15:49:15.000Z","updated_at":"2025-03-17T00:27:08.000Z","dependencies_parsed_at":"2024-01-08T02:03:41.586Z","dependency_job_id":"2f55afcd-5c57-4f59-bbf3-24bd1097db80","html_url":"https://github.com/openedx/frontend-app-gradebook","commit_stats":null,"previous_names":["edx/gradebook","edx/frontend-app-gradebook"],"tags_count":79,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openedx%2Ffrontend-app-gradebook","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openedx%2Ffrontend-app-gradebook/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openedx%2Ffrontend-app-gradebook/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openedx%2Ffrontend-app-gradebook/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openedx","download_url":"https://codeload.github.com/openedx/frontend-app-gradebook/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247622985,"owners_count":20968575,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-13T10:23:21.019Z","updated_at":"2025-04-07T09:18:25.647Z","avatar_url":"https://github.com/openedx.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# frontend-app-gradebook\n\n[![Build Status](https://api.travis-ci.com/edx/frontend-app-gradebook.svg?branch=master)](https://travis-ci.com/edx/frontend-app-gradebook)\n[![Codecov](https://img.shields.io/codecov/c/gh/openedx/frontend-app-gradebook)](https://app.codecov.io/gh/openedx/frontend-app-gradebook)\n[![npm_version](https://img.shields.io/npm/v/@edx/frontend-app-gradebook.svg)](@edx/frontend-app-gradebook)\n[![npm_downloads](https://img.shields.io/npm/dt/@edx/frontend-app-gradebook.svg)](@edx/frontend-app-gradebook)\n[![license](https://img.shields.io/npm/l/@edx/frontend-app-gradebook.svg)](@edx/frontend-app-gradebook)\n[![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)\n\n# Purpose\n\nGradebook allows course staff to view, filter, and override subsection grades for a course. Additionally for Masters courses, Gradebook enables bulk management of subsection grades.\n\nJump to:\n\n- [Should I use Gradebook in my course?](#should-i-use-gradebook-in-my-course)\n- [Quickstart](#quickstart)\n\nFor existing documentation see:\n\n- Basic Usage: [Review Learner Grades (read-the-docs)](https://edx.readthedocs.io/projects/edx-partner-course-staff/en/latest/student_progress/course_grades.html#review-learner-grades-on-the-instructor-dashboard)\n- Bulk Grade Management: [Override Learner Subsection Scores in Bulk (read-the-docs)](https://edx.readthedocs.io/projects/edx-partner-course-staff/en/latest/student_progress/course_grades.html#override-learner-subsection-scores-in-bulk)\n\n## Should I use Gradebook in my course?\n\n### What does this offer over the legacy gradebook?\n\nThe micro-frontend offers a great deal more granularity when searching for problems, an easy interface for editing grades, an \naudit trail for seeing who edited what grade and what reason they gave (if any) for doing so.\n\nUsageProblems can be filtered by student as in the traditional gradebook, but can also be filtered by scores to see who\nscored within a certain range, and by assignment types (note: Not problem types, but categories like ‘Exams’ or\n‘Homework’).\n\n### What does the legacy gradebook offer that this project does not?\n\nThis project does not (yet, at least) create any graphs, which the traditional gradebook does. It also does not give\nquick links to the problems for the instructor to visit. It expects the instructor to be familiar with the problems they\nare grading and which unit they refer to.\n\nThe gradebook is expected to be much more performant for larger numbers of students as well. The Instructor Dashboard\nlink for the legacy gradebook reports that \"this feature is available only to courses with a small number of enrolled \nlearners.\" However, this project comes with no such warning.\n\n### Who should not change to this gradebook?\n\nGroups whose instructors need not ever manually override grades do not need this project, but may not be any worse off\ndepending on their needs. Instructors that expect to review grades infrequently enough that not having a direct link\nto the problem in question will have a worse UX than the legacy gradebook provides. Instructors that rely on the graphs\ngenerated by the current gradebook might find the lack of autogenerated graphs to be frustrating.\n\n## Getting Started\n\n\n### Installation\n\nTo install gradebook into your project:\n```\nnpm i --save @edx/frontend-app-gradebook\n```\nCloning and Startup\n===================\n\n1. Clone your new repo:\n\n  ``git clone https://github.com/openedx/frontend-app-gradebook.git``\n\n2. Install npm dependencies:\n\n  ``cd frontend-app-gradebook \u0026\u0026 npm install``\n\n3. Start the dev server:\n\n  ``npm start``\n\n## Running the UI Standalone\n\nTo install the project please refer to the [`edX Developer Stack`](https://github.com/openedx/devstack) instructions.\n\nThe web application runs on port **1994**, so when you go to `http://localhost:1994/course-v1:edX+DemoX+Demo_Course` you should see the UI (assuming you have such a Demo Course in your devstack).  Note that you always have to provide a course id to actually see a gradebook.\n\nIf you don't, you can see the log messages for the docker container by executing `make gradebook-logs` in the `devstack` directory.\n\nNote that starting the container executes the `npm run start` script which will hot-reload JavaScript and Sass files changes, so you should (:crossed_fingers:) not need to do anything (other than wait) when making changes.\n\n## Configuring for local use in edx-platform\n\nAssuming you've got the UI running at `http://localhost:1994`, you can configure the LMS in edx-platform\nto point to your local gradebook from the instructor dashboard by putting this setting in `lms/env/private.py`:\n```\nWRITABLE_GRADEBOOK_URL = 'http://localhost:1994'\n```\n\nThere are also several edx-platform waffle and feature flags you'll have to enable from the Django admin:\n\n1. Grades \u003e Persistent grades enabled flag.  Add this flag if it doesn't exist,\ncheck the ``enabled`` and ``enabled for all courses`` boxes.\n\n2. Waffle \u003e Switches.  Add the ``grades.assume_zero_grade_if_absent`` switch and make it active.\n\n3. Waffle_utils \u003e Waffle flag course overrides.  Activate waffle flags for courses where you want to enable Gradebook functionality:\n    - Enable Gradebook by adding the ``grades.writable_gradebook`` add checking the ``enabled`` box.\n    - Enable Bulk Grade Management by adding the ``grades.bulk_management`` flag and checking the ``enabled`` box.\n\n    Alternatively, you could add these as regular waffle flags to enable the functionality for all courses.\n\n**NOTE:** IF the above flags are not configured correctly, the gradebook may appear to work, but will return bogus\nnumbers for grades. If your gradebook isn't accepting your changes, or the changes aren't resulting in sane, \nrecalculated grade values, verify you've set all flags correctly.\n\n## Plugins\nThis MFE can be customized using [Frontend Plugin Framework](https://github.com/openedx/frontend-plugin-framework).\n\nThe parts of this MFE that can be customized in that manner are documented [here](/src/plugin-slots).\n\n## Running tests\n\n1. Assuming that you're operating in the context of the edX devstack,\nrun `gradebook-shell` from your devstack directory.  This will start a bash shell inside your\nrunning gradebook container.\n2. Run `make test` (which executes `npm run test`).  This will run all of the gradebook tests.\n\n## Directory Structure\n\n* `config`\n  * Directory for [`webpack`](https://webpack.js.org/) configurations\n* `public`\n  * Entry point for the single-page application - `gradebook` has a single `index.html` file\n* `src`\n  * `components`\n    * Directory for presentational `React` components\n  * `containers`\n    * Directory for container `React` components\n  * `data`\n    * `actions`\n      * Directory for `Redux` action creators\n    * `constants`\n    * `reducers`\n      * Directory for `Redux` reducers\n\n## Authentication with backend API services\n\nSee the [`@edx/frontend-auth`](https://github.com/edx-unsupported/frontend-auth) repo for information about securing routes in your application that require user authentication.\n\nLicense\n=======\n\nThe code in this repository is licensed under the AGPLv3 unless otherwise\nnoted.\n\nContributing\n============\n\nContributions are very welcome.  Please read `How To Contribute`_ for details.\n\n.. _How To Contribute: https://openedx.org/r/how-to-contribute\n\nThis project is currently accepting all types of contributions, bug fixes,\nsecurity fixes, maintenance work, or new features.  However, please make sure\nto have a discussion about your new feature idea with the maintainers prior to\nbeginning development to maximize the chances of your change being accepted.\nYou can start a conversation by creating a new issue on this repo summarizing\nyour idea.\n\nGetting Help\n===========\n\nIf you're having trouble, we have discussion forums at\nhttps://discuss.openedx.org where you can connect with others in the community.\n\nOur real-time conversations are on Slack. You can request a `Slack\ninvitation`_, then join our `community Slack workspace`_.  Because this is a\nfrontend repository, the best place to discuss it would be in the `#wg-frontend\nchannel`_.\n\nFor anything non-trivial, the best path is to open an issue in this repository\nwith as many details about the issue you are facing as you can provide.\n\nhttps://github.com/openedx/frontend-app-gradebook/issues\n\nFor more information about these options, see the `Getting Help`_ page.\n\n.. _Slack invitation: https://openedx.org/slack\n.. _community Slack workspace: https://openedx.slack.com/\n.. _#wg-frontend channel: https://openedx.slack.com/archives/C04BM6YC7A6\n.. _Getting Help: https://openedx.org/community/connect\n\nThe Open edX Code of Conduct\n============================\n\nAll community members are expected to follow the `Open edX Code of Conduct`_.\n\n.. _Open edX Code of Conduct: https://openedx.org/code-of-conduct/\n\nReporting Security Issues\n=========================\nPlease do not report security issues in public. Please email security@openedx.org.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenedx%2Ffrontend-app-gradebook","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenedx%2Ffrontend-app-gradebook","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenedx%2Ffrontend-app-gradebook/lists"}