CONTRIBUTING.md

Contributing

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 npm run release-all.

NPM tasks

Task	Description
watch	Watches for file changes and update.
test	Runs all jasmine tests.
grails2:debug	Builds all debug resources and copy to grails2.
grails3:debug	Builds all debug resources and copy to grails3.
debug-all	Builds all debug resources and copy to grails2 and grails3.
grails2:release	Builds all release resources and copy to grails2.
grails3:release	Builds all release resources and copy to grails3.
release-all	Builds all release resources and copy to graisl2 and grails3.

File structure

.
│── app             # test app
│── plugin          # 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 app