Contributing

January 20, 2016 · View on GitHub

This plugin uses Gulp to build its resources.

Building

  1. Change to the project's root directory.
  2. Install project dependencies with npm install.
  3. Build the resources with gulp release-all.

Gulp tasks

TaskDescription
watchWatches for file changes and update.
testRuns all jasmine tests.
grails2:debugBuilds all debug resources and copy to grails2.
grails3:debugBuilds all debug resources and copy to grails3.
debug-allBuilds all debug resources and copy to grails2 and grails3.
grails2:releaseBuilds all release resources and copy to grails2.
grails3:releaseBuilds all release resources and copy to grails3.
release-allBuilds all release resources and copy to graisl2 and grails3.

File structure

.
├── grails2
│   ├── app             # grails2 test app 
│   └── plugin          # grails2 plugin    
├── grails3
│   ├── app             # grails3 test app
│   └── plugin          # grails3 plugin
├── web                 # shared web resources
│   ├── app             # coffeescript
│   ├── img
│   ├── spec            # jasmine
│   ├── styles          # less
│   ├── templates       # handlebars templates
│   └── vendor          # vendor libs
├── gulpfile.js
└── package.json

Running

When developing, use grails2/app and grails3/app.