generator-craftcms


Yeoman generator

Workflow for Craft with Gulp

Requires Nodejs and Gulp

Getting started

Install the generator

$ npm install -g yo

To install generator-craftcms from npm, run:

$ npm install -g generator-craftcms

Finally, initiate the generator:

$ yo craftcms

Compass needs the compass ruby gem. If you don't already have it: gem update --system and gem install compass

Tasks

note: Don't touch the templates folder in /craft it will be overwritten on build. Work on the ones in app/templates

• gulp watch to start the watch task, at the moment you will have to use a browser extention for live reload.

• gulp to build for production, all the magic happens and template files will be moved to craft/templates, resources (images/js/css) will be concatinated, minified and wrapped in silk before they end up in /public. Having some issues with uglyfication of js.

• gulp bower Injects bower dependencies into _layout.html. This task will run on gulp watch as well. Remember to --save when installing components.

Set /app as server root on development and /public for production.

Gulp Plugins

• compass - Css compiler

• autoprefixer - So we don't have to write -moz-, -webkit-, -ms-, -o-, -all-, -the-, -time-

• concat - Merging css and js to single files

• uglify - Javascript minifyer

• jshint - A tool that helps to detect errors and potential problems in your JavaScript code.

• watch - The thing that tells us when a file has changed

• livereload - Updates our browsers when js or css changes

• usemin - Reads the html to know what files to concat and stuff

• util - Logs stuff. And it can gutil.beep(); too :o

• del - Our garbage guy

• cache - A temp file based caching proxy task for Gulp.

• imagemin - Optimizes images for you.

• wiredep - Injects script and link tags when you install something with bower.