Skip to content

Latest commit

 

History

History
202 lines (131 loc) · 6.1 KB

README.rst

File metadata and controls

202 lines (131 loc) · 6.1 KB
Raw

frontend-app-ora-grading

CI Codecov Documentation License status-badge

Purpose

The ORA Staff Grading App is a micro-frontend (MFE) staff grading experience for Open Response Assessments (ORAs). This experience was designed to streamline the grading process and enable richer previews of submission content and, eventually, replace on-platform grading workflows for ORA.

When enabled, ORAs with a staff grading step will link to this new MFE when clicking "Grade Available Responses" from the ORA or link in the instructor dashboard.

The ORA Staff Grader depends on the lms/djangoapps/ora_staff_grader app in edx-platform.

Getting Started

Developing

One Time Setup

First, clone the repo, install code prerequisites, and start the app.

# Clone the repository
git clone [email protected]:openedx/frontend-app-ora-grading.git
cd frontend-app-ora-grading

# Install prerequisites
npm install

# Start the MFE
npm run start

The app will, by default, run on http://localhost:1993 unless otherwise specified in .env.development:PORT and .env.development:BASE_URL.

Next, enable the ORA Grading micro-frontend in edx-platform

  1. Add the path to the ORA Grading app in edx-platform:
    1. Go to your environment settings (e.g. edx-platform/lms/envs/private.py)
    2. Add the environment variable, ORA_GRADING_MICROFRONTEND_URL pointing to the ORA Grading app location (e.g. http://localhost:1993).
  2. Start / restart the edx-platform lms.
  3. Enable the ORA Grading feature in Django Admin.
    1. Go to Django Admin ({lms-root}/admin)
    2. Navigate to django-waffle > Flags and click add/enable a new flag.
    3. Add a new flag called openresponseassessment.enhanced_staff_grader and enable it.

From there, visit an Open Response Assessment with a Staff Graded Step and click the "View and grade responses" button to begin grading in the ORA Staff Grader experience.

Making Changes

Get / install the latest code:

# Grab the latest code
git checkout master
git pull

# Install/update the dev requirements
npm install

Before committing:

# Make a new branch for your changes
git checkout -b <your_github_username>/<short_description>

# Using your favorite editor, edit the code to make your change.

# Run your new tests
npm test

# Commit all your changes
git commit ...
git push

# Open a PR and ask for review.

Deploying

This component follows the standard deploy process for MFEs. For details, see the MFE production deployment guide

Getting Help

Documentation

See ORA Staff Grading on ReadTheDocs for more in-depth usage information.

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

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-ora-grading/issues

For more information about these options, see the Getting Help page.

License

The code in this repository is licensed under the GNU Affero General Public License v3.0 unless otherwise noted.

Please see LICENSE for details.

Contributing

This project is currently only accepting bug fixes, security fixes, and maintenance work. New features should be discussed in advance with the owning team and added to the public roadmap or they may not be accepted. You can start a conversation by creating a new issue on this repo summarizing your feature idea.

Please read How To Contribute for details.

The Open edX Code of Conduct

All community members are expected to follow the Open edX 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.

Reporting Security Issues

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