Skip to content

Latest commit

 

History

History
executable file
·
197 lines (133 loc) · 8.88 KB

README.md

File metadata and controls

executable file
·
197 lines (133 loc) · 8.88 KB
Raw

frontend-app-gradebook

Build Status Codecov npm_version npm_downloads license semantic-release

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.

Jump to:

For existing documentation see:

Should I use Gradebook in my course?

What does this offer over the legacy gradebook?

The micro-frontend offers a great deal more granularity when searching for problems, an easy interface for editing grades, an audit trail for seeing who edited what grade and what reason they gave (if any) for doing so.

UsageProblems can be filtered by student as in the traditional gradebook, but can also be filtered by scores to see who scored within a certain range, and by assignment types (note: Not problem types, but categories like ‘Exams’ or ‘Homework’).

What does the legacy gradebook offer that this project does not?

This project does not (yet, at least) create any graphs, which the traditional gradebook does. It also does not give quick links to the problems for the instructor to visit. It expects the instructor to be familiar with the problems they are grading and which unit they refer to.

The gradebook is expected to be much more performant for larger numbers of students as well. The Instructor Dashboard link for the legacy gradebook reports that "this feature is available only to courses with a small number of enrolled learners." However, this project comes with no such warning.

Who should not change to this gradebook?

Groups whose instructors need not ever manually override grades do not need this project, but may not be any worse off depending on their needs. Instructors that expect to review grades infrequently enough that not having a direct link 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.

Getting Started

Installation

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

  1. Install npm dependencies:

cd frontend-app-gradebook && npm install

  1. Start the dev server:

npm start

Running the UI Standalone

To install the project please refer to the edX Developer Stack instructions.

The 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.

If you don't, you can see the log messages for the docker container by executing make gradebook-logs in the devstack directory.

Note 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.

Configuring for local use in edx-platform

Assuming you've got the UI running at http://localhost:1994, you can configure the LMS in edx-platform to point to your local gradebook from the instructor dashboard by putting this setting in lms/env/private.py:

WRITABLE_GRADEBOOK_URL = 'http://localhost:1994'

There are also several edx-platform waffle and feature flags you'll have to enable from the Django admin:

  1. Grades > Persistent grades enabled flag. Add this flag if it doesn't exist, check the enabled and enabled for all courses boxes.

  2. Waffle > Switches. Add the grades.assume_zero_grade_if_absent switch and make it active.

  3. Waffle_utils > Waffle flag course overrides. Activate waffle flags for courses where you want to enable Gradebook functionality:

    • Enable Gradebook by adding the grades.writable_gradebook add checking the enabled box.
    • Enable Bulk Grade Management by adding the grades.bulk_management flag and checking the enabled box.

    Alternatively, you could add these as regular waffle flags to enable the functionality for all courses.

NOTE: IF the above flags are not configured correctly, the gradebook may appear to work, but will return bogus numbers for grades. If your gradebook isn't accepting your changes, or the changes aren't resulting in sane, recalculated grade values, verify you've set all flags correctly.

Plugins

This MFE can be customized using Frontend Plugin Framework.

The parts of this MFE that can be customized in that manner are documented here.

Running tests

  1. Assuming that you're operating in the context of the edX devstack, run gradebook-shell from your devstack directory. This will start a bash shell inside your running gradebook container.
  2. Run make test (which executes npm run test). This will run all of the gradebook tests.

Directory Structure

  • config
    • Directory for webpack configurations
  • public
    • Entry point for the single-page application - gradebook has a single index.html file
  • src
    • components
      • Directory for presentational React components
    • containers
      • Directory for container React components
    • data
      • actions
        • Directory for Redux action creators
      • constants
      • reducers
        • Directory for Redux reducers

Authentication with backend API services

See the @edx/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 [email protected].