User documentation available on ReadTheDocs.

The intent of this project is to be installed as Django apps that will be included in edx-platform.

To install all dependencies (assumes Ubuntu 12.04):

make install

./scripts/workbench.sh

By default, the XBlock JavaScript will be combined and minified. To preserve indentation and line breaks in JavaScript source files:

DEBUG_JS=1 ./scripts/workbench.sh

Additional arguments are passed to runserver. For example, to start the server on port 8001:

./scripts/workbench.sh 8001

To reduce page size, the OpenAssessment XBlock serves combined/minified versions of JavaScript and CSS. This combined/minified files are checked into the git repository.

If you modify JavaScript or Sass, you MUST regenerate the combined/minified files:

# Combine/minify JavaScript
make javascript

# Combine/minify CSS (from Sass)
./scripts/sass.sh

Make sure you commit the combined/minified files to the git repository!

To run all tests:

make test

To limit Python tests to a particular module:

./scripts/test-python.sh openassessment/xblock/test/test_openassessment.py

To run just the JavaScript tests:

./scripts/test-js.sh

To run the JavaScript tests in Chrome so you can use the debugger:

./scripts/js-debugger.sh

You will need to:

1. Install i18n-tools.
2. Configure Transifex, as described in the docs.
3. Install gettext.

To extract strings and push to Transifex

./scripts/i18n-push.sh

To pull strings from Transifex

./scripts/i18n-pull.sh

The code in this repository is licensed under version 3 of the AGPL unless otherwise noted.

Please see LICENSE.txt for details.

Contributions are very welcome. The easiest way is to fork this repo, and then make a pull request from your fork. The first time you make a pull request, you may be asked to sign a Contributor Agreement.

Please do not report security issues in public. Please email security@edx.org

You can discuss this code on the edx-code Google Group or in the edx-code IRC channel on Freenode.