development.md

Development Documentation

The MOOC.IP plugin ships with a build script that automates several steps which are performed during the development cycle. When you cloned the plugin source code using Git, you'll have to install all dependencies. After that, you have to compile LESS files into CSS.

Installing Dependencies

The MOOC.IP plugin uses Composer as the dependency manager. Make sure that you have installed it globally. Then, run the composer command to install all required dependencies:

$ composer install

Compile LESS Files

Run the build script to compile the LESS files into CSS files and create the minified productive CSS file (namely assets/courseware.min.css):

$ php build.php less

If you frequently modify the LESS files and don't want to compile them after each modification manually, you can use the watch task:

$ php build.php watch

The watch task periodically checks for changes in the plugin's asset files and dumps them on demand. You can adjust the timeout between to cycles by passing the time to sleep in second as an argument to the task (the default timeout is five seconds):

$ php build.php watch 10

Create the Plugin Archive

You can create an installable Stud.IP plugin archive using the zip command (make your that you have installed all dependencies and that you have compiled the LESS files):

$ php build.php zip