This XBlock is a edX course applet that served a collaborative multimodal annotation feature. This package also includes NodeJS server that runs standalone.

RichReviewXBlock is an XBlock implementation of RichReview annotation system that can run on the edx-platform of open-edX. To setup a testing environment, please taks a look at the devstack description.

RichReview serves annotation data via django-pyfs file system abstraction. There are two options for the file storage database: your server's local storage or Amazon S3 storage. For this, you will want to set DJFS environment variable. It's in /edx/app/edxapp/{cms,lms}.auth.json files.

Set DJFS of cms.auth.json like this (as it is including {platform_revision}):

"DJFS": {
    "directory_root": "common/static/djpyfs",
    "type": "osfs",
    "url_root": "/static/{platform_revision}/djpyfs"
},

Set DJFS of lms.auth.json like this (not that there's no {platform_revision}):

"DJFS": {
    "directory_root": "common/static/djpyfs",
    "type": "osfs",
    "url_root": "/static/djpyfs"
},

This setting places the local directory under the common, so that LMS can have access to the PDF files uploaded from CMS.

Set DJFS like this:

"DJFS": {
        "type": "s3fs",
        "bucket": "richreview.edx",
        "prefix": "rrfs",
        "aws_access_key_id": "<your Amazon access key id>",
        "aws_secret_access_key": "<your Amazon secret access key>"
}

and go to your Amazon S3 console, create a bucket named richreview.edx. RichReviewXBlock will store all of its data in this bucket. To make this folder accessable to your edX server across the different domains, you have to set CORS setting. Right click on the richreview.edx bucket, select Properties, select Permission on the right panel, select CORS Configuration tab, and set it as below:

<?xml version="1.0" encoding="UTF-8"?>
<CORSConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
    <CORSRule>
        <AllowedOrigin>http://localhost:8001</AllowedOrigin>
        <AllowedOrigin>http://*.edx.org</AllowedOrigin>
        <AllowedMethod>GET</AllowedMethod>
        <MaxAgeSeconds>3000</MaxAgeSeconds>
        <AllowedHeader>Authorization</AllowedHeader>
    </CORSRule>
</CORSConfiguration>

Great then you are all set with the Amazon S3 storage.

Then install this XBlock (note that this operation can take up several minutes). You can either do:

pip install git+git://github.com/DongwookYoon/RichReviewXBlock.git

or

pip install git clone https://github.com/DongwookYoon/RichReviewXBlock.git
pip install RichReviewXBlock/

In the studio, go to a course's setting, and add richreview to the Advanced Module List.

Now you are all ready to add RichReview module to your course!

The code in this repository is licensed under the AGPL license unless otherwise noted.

Please email dy252@cornell.edu.