Merge branch 'master' of github.com:edx/frontend-app-ora-grading into…

… Ali-Abbas/react-router-upgrade

.eslintrc.js

@@ -11,6 +11,7 @@ const config = createConfig('eslint', {
     "react/forbid-prop-types": ["error", { "forbid": ["any", "array"] }], // arguable object proptype is use when I do not care about the shape of the object
     'no-import-assign': 'off',
     'no-promise-executor-return': 'off',
+    'import/no-cycle': 'off',
   },
 });
 

.github/workflows/ci.yml

@@ -11,17 +11,16 @@ on:
 jobs:
   tests:
     runs-on: ubuntu-20.04
-    strategy:
-      matrix:
-        node: [16]
     steps:
     - name: Checkout
-      uses: actions/checkout@v2
-
+      uses: actions/checkout@v3
+    - name: Setup Nodejs Env
+      run: echo "NODE_VER=`cat .nvmrc`" >> $GITHUB_ENV
     - name: Setup Nodejs
-      uses: actions/setup-node@v2
+      uses: actions/setup-node@v3
+# Because of node 18 bug (https://github.com/nodejs/node/issues/47563), Pinning node version 18.15 until the next release of node
       with:
-        node-version: ${{ matrix.node }}
+        node-version: 18.15
 
     - name: Install dependencies
       run: npm ci

.github/workflows/lockfileversion-check.yml

@@ -10,4 +10,4 @@ on:
 
 jobs:
   version-check:
-    uses: openedx/.github/.github/workflows/lockfileversion-check.yml@master
+    uses: openedx/.github/.github/workflows/lockfileversion-check-v3.yml@master

.nvmrc

@@ -0,0 +1 @@
+18.16

Makefile

@@ -3,8 +3,9 @@ npm-install-%: ## install specified % npm package
 	git add package.json
 
 transifex_resource = frontend-app-ora-grading
-transifex_langs = "ar,fr,es_419,zh_CN"
+transifex_langs = "ar,fr,es_419,zh_CN,fr_CA,it_IT,pt_PT,de_DE,uk,ru,hi"
 
+intl_imports = ./node_modules/.bin/intl-imports.js
 transifex_utils = ./node_modules/.bin/transifex-utils.js
 i18n = ./src/i18n
 transifex_input = $(i18n)/transifex_input.json
@@ -53,9 +54,24 @@ push_translations:
 	# Pushing comments to Transifex...
 	./node_modules/@edx/reactifex/bash_scripts/put_comments_v3.sh
 
+ifeq ($(OPENEDX_ATLAS_PULL),)
 # Pulls translations from Transifex.
 pull_translations:
 	tx pull -t -f --mode reviewed --languages=$(transifex_langs)
+else
+# Experimental: OEP-58 Pulls translations using atlas
+pull_translations:
+	rm -rf src/i18n/messages
+	mkdir src/i18n/messages
+	cd src/i18n/messages \
+	  && atlas pull --filter=$(transifex_langs) \
+	           translations/frontend-component-footer/src/i18n/messages:frontend-component-footer \
+	           translations/frontend-component-header/src/i18n/messages:frontend-component-header \
+	           translations/paragon/src/i18n/messages:paragon \
+	           translations/frontend-app-ora-grading/src/i18n/messages:frontend-app-ora-grading
+
+	$(intl_imports) frontend-component-footer frontend-component-header paragon frontend-app-ora-grading
+endif
 
 # This target is used by CI.
 validate-no-uncommitted-package-lock-changes:

README.rst

@@ -0,0 +1,202 @@
+frontend-app-ora-grading
+########################
+
+|ci-badge| |codecov-badge| |doc-badge| |license-badge| |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
+<https://github.com/openedx/edx-platform/tree/master/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.
+
+.. code-block::
+
+  # 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`
+
+#. Add the path to the ORA Grading app in `edx-platform`:
+
+   #. Go to your environment settings (e.g. `edx-platform/lms/envs/private.py`)
+
+   #. Add the environment variable, ``ORA_GRADING_MICROFRONTEND_URL`` pointing
+      to the ORA Grading app location (e.g. ``http://localhost:1993``).
+
+#. Start / restart the ``edx-platform`` ``lms``.
+
+#. Enable the ORA Grading feature in Django Admin.
+
+   #. Go to Django Admin (`{lms-root}/admin`)
+
+   #. Navigate to ``django-waffle`` > ``Flags`` and click ``add/enable a new
+      flag``.
+
+   #. 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:
+
+.. code-block::
+
+  # Grab the latest code
+  git checkout master
+  git pull
+
+  # Install/update the dev requirements
+  npm install
+
+
+Before committing:
+
+.. code-block::
+
+  # 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`_
+
+.. _MFE production deployment guide: https://openedx.github.io/frontend-platform/#production-deployment-strategy
+
+Getting Help
+************
+
+Documentation
+=============
+
+See `ORA Staff Grading on ReadTheDocs`_ for more in-depth usage information.
+
+.. _ORA Staff Grading on ReadTheDocs: https://edx.readthedocs.io/projects/edx-partner-course-staff/en/latest/exercises_tools/open_response_assessments/ORA_Staff_Grading.html#ora-staff-grading
+
+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.
+
+.. _Slack invitation: https://openedx.org/slack
+.. _community Slack workspace: https://openedx.slack.com/
+.. _Getting Help: https://openedx.org/getting-help
+
+License
+*******
+
+The code in this repository is licensed under the GNU Affero General Public
+License v3.0 unless otherwise noted.
+
+Please see `LICENSE <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 <https://openedx.org/r/how-to-contribute>`_ for
+details.
+
+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/
+
+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.
+
+.. _Backstage: https://open-edx-backstage.herokuapp.com/catalog/default/component/frontend-app-ora-grading
+
+Reporting Security Issues
+*************************
+
+Please do not report security issues in public. Please email [email protected].
+
+.. |ci-badge| image:: https://github.com/openedx/frontend-app-ora-grading/actions/workflows/ci.yml/badge.svg
+    :target: https://github.com/openedx/frontend-app-ora-grading/actions/workflows/ci.yml
+    :alt: CI
+
+.. |codecov-badge| image:: https://codecov.io/github/openedx/frontend-app-ora-grading/coverage.svg?branch=master
+    :target: https://codecov.io/github/openedx/frontend-app-ora-grading?branch=master
+    :alt: Codecov
+
+.. |doc-badge| image:: https://readthedocs.org/projects/frontend-app-ora-grading/badge/?version=latest
+    :target: https://edx.readthedocs.io/projects/edx-partner-course-staff/en/latest/exercises_tools/open_response_assessments/ORA_Staff_Grading.html
+    :alt: Documentation
+
+.. |license-badge| image:: https://img.shields.io/github/license/openedx/frontend-app-ora-grading.svg
+    :target: https://github.com/openedx/frontend-app-ora-grading/blob/master/LICENSE
+    :alt: License
+
+.. |status-badge| image:: https://img.shields.io/badge/Status-Maintained-brightgreen

catalog-info.yaml

@@ -0,0 +1,19 @@
+# This file records information about this repo. Its use is described in OEP-55:
+# https://open-edx-proposals.readthedocs.io/en/latest/processes/oep-0055-proc-project-maintainers.html
+
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+  name: 'frontend-app-ora-grading'
+  description: "Frontend grading experience for Open Response Assessments (ORAs)"
+  links:
+    - url: "https://ora-grading.edx.org"
+      title: "Production Site"
+      icon: "Web"
+    - url: "https://ora-grading.stage.edx.org"
+      title: "Stage Site"
+      icon: "Web"
+spec:
+  owner: group:content-aurora
+  type: 'website'
+  lifecycle: 'production'