MGC is a domain specific language based on AngularJS, intended for mathematics education web publishing.
- AngularJS v1.0.1+ is currently required.
- jQuery / Plugins (depends on directive). Check specific directive dependencies for more information
The repository comes with the modules pre-built and compressed into the build/
directory.
angular.module('myApp', ['mgc']);
The modules can be found in the Directives, Filters, Services and Controllers folders. Check out the readme file associated with each module for specific module usage information.
You do not need to build the project to use it - see above - but if you are working on it then this is what you need to know.
-
Install Node.js and npm (which comes with node)
-
Install local dependencies:
$ npm install
-
Install global dependencies
grunt
, andtestacular
:$ npm install -g testacular grunt
Before you commit, always run grunt
to build and test everything once.
$ grunt
The modules come with unit tests that should be run on any changes and certainly before committing changes to the project. The unit tests should also provide further insight into the usage of the modules.
First, start the testacular server:
$ grunt server
Then, open your browser to http://localhost:8080 and run the watch command to re-run tests on every save:
$ grunt watch