edX UI Toolkit
A JavaScript toolkit for building edX user interfaces.
Table of Contents
- Overview
- License
- Contributions
- Getting Started
- Linting
- Tests
Overview
This library contains the following:
- Backbone views to implement patterns as defined by the edX Pattern Library: http://ux.edx.org/
- Utility methods to simplify the creation and testing of user interfaces
License
The code in this repository uses the Apache 2.0 license unless otherwise
noted. Please see the LICENSE file for details.
Contributions
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 refer to our contributor guidelines
in the main edx-platform repo for important additional information.
Getting Started
-
Get the code (e.g. clone the repository).
-
Install the Node requirements:
$ npm install
Linting
$ gulp lint
Tests
To run tests in headless mode:
$ gulp test
To run tests in debug mode:
$ gulp test_debug
Once tests are running in debug mode, open this URL:
http://localhost:9009/debug.html