Ourcane

A Yeoman generator used to start projects at Arcane Digital Inc.

Requirements

• node v0.12.2
• bower v1.3.12
• sass v3.4

OS X

OS X Yosemite and Mavericks both ship with Ruby 2.0. If you are using an older version of OS X, follow the Homebrew Instructions

sudo gem install sass

Windows

After installing Node for windows, use the windows specific Ruby Installer

sudo gem install sass

Installing

We recommend you install the generator using the -g flag and if you are on a Mac/Linux to use sudo as well.

sudo npm install -g generator-ourcane

Updating

To only update the tasks and not overwrite your template/sass/js files use:

sudo npm update -g generator-ourcane
yo ourcane --update-tasks

Tasks

scripts

Uses Browserify to allow for node-style 'requires' of libraries. Compiles the /src/scripts/app.js file and places it in the assets folder specificed in the config file. Default is /public/assets/js/app.js

gulp scripts

styles

Uses libsass for compiling of scss files. During compilation it also runs minifycss and autoprefixer to optimize your css files.

gulp styles

fonts

gulp fonts

images

gulp images

videos

gulp videos

icons

gulp icons

watch

gulp watch

init

gulp init

Custom Tasks

You can create your own tasks or even override existing tasks. You can set multiple task directories within the config.json. They are loaded into memory by scanning and merging the folders left to right in the array. By placing your own tasks in a src/tasks folder you can extend or override existing tasks.

Task Template

module.exports = function (gulp, plugins, config) {
    var deferred = plugins.Q.defer();
    gulp.src('src/foo')
    .pipe(gulp.dest('public/bar'))
    .on('end', function () {
        plugins.notifier.notify({title: 'Task Complete', message: 'Foo Bar task complete!'});
        deferred.resolve();
    });
    return deferred.promise;
};

Contributors

Development team at @arcanebrand

The MIT License (MIT)

Copyright (c) 2015 Arcane Digital Inc

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.