README.rst 2.19 KB
Newer Older
1
.. image:: https://travis-ci.org/edx/edx-ora2.png?branch=master
2 3
    :alt: Travis build status

4

5 6
.. image:: https://coveralls.io/repos/edx/edx-ora2/badge.png?branch=master
    :target: https://coveralls.io/r/edx/edx-ora2?branch=master
7 8
    :alt: Coverage badge

9

10 11 12 13
This is an initial prototype for redesigning Peer Grading and general Open Ended
Submission Evaluation. This project is in the early stages of development and is
not ready for general use.

14

15 16 17 18
Installation
============

The intent of this project is to be installed as Django apps that will be
19 20
included in `edx-platform <https://github.com/edx/edx-platform>`_.

21 22
For JavaScript minification and unit tests, you must `install NodeJS <http://nodejs.org/>`_.

23
To install dependencies and start the development ("workbench") server:
24

25
.. code:: bash
26

27
    ./scripts/workbench.sh
28

29 30 31 32 33 34 35 36 37 38 39
By default, the XBlock JavaScript will be combined and minified.  To
preserve indentation and line breaks in JavaScript source files:

.. code:: bash

    DEBUG_JS=1 ./scripts/workbench.sh

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

.. code:: bash
40

41
    ./scripts/workbench.sh 8001
42 43


44 45 46
Running Tests
=============

47
To run the Python and Javascript unit test suites:
48 49 50

.. code:: bash

51
    ./scripts/test.sh
52 53


Will Daly committed
54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75
Quality Check
=============

Install pylint:

.. code:: bash

    pip install pylint==0.28.0

Check for quality violations:

.. code:: bash

    pylint apps

Disable quality violations on a line or file:

.. code:: python

    # pylint: disable=W0123,E4567


76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101
License
=======

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

Please see ``LICENSE.txt`` for details.

How to Contribute
=================

Due to the very early stage of development we're at, we are not accepting
contributions at this time. Large portions of the API can change with little
notice.

Reporting Security Issues
=========================

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

Mailing List and IRC Channel
============================

You can discuss this code on the
`edx-code Google Group <https://groups.google.com/forum/#!forum/edx-code>`_ or
in the `edx-code` IRC channel on Freenode.