generator-yello v0.1.0

NB: THIS IS NOT A PUBLICALLY SUPPORTED PACKAGE

Yello Studio Project Boilerplate

Born out of the need to standardise development within our agency.

Getting set up - you only need to do this once.

Make sure the required packages are installed globally, you will only need to do this once, and only if you do not have the following packages already installed on your machine.

STEP 1: Install/update Node JS

Install Node JS, either direct from the website: https://nodejs.org/en/ or using Homebrew:

$ brew install node

STEP 2: Install global packages

Yeoman, Bower, Gulp, Browser-Sync and the Yello Generator

Front end dependancy management

$ npm install -g yo bower gulp browser-sync generator-yello

STEP 3: Install Sass and related Gems

SASS (Syntactically Awesome Stylesheets)

$ gem [install/update] sass

Bourbon and Neat

$ gem install bourbon
$ gem install neat		

How to use:

Begin by creating a Git Repository on Github or Bitbucket then create a new directory and setting it up as a local git repository using the following commands:

$ cd Sites
$ mkdir {projectname}
$ cd {projectname}

$ git init
$ git remote add origin https://username@bitbucket.org/username/reponame.git

Craft Websites

(Optionally) Install Craft by copying a fresh version of craft into your project directory.

* Don't forget to add a new host entry into MAMP for www.projectname.loc

Now run the generator to build the file structure and add the template files:

$ yo yello

Finally run gulp to serve up your page using browser-sync

$ gulp serve

That's it, now go, create magical things!

Existing projects:

When cloning an existing repository from Github or Bitbucket:

$ cd Sites
$ git clone https://username@bitbucket.org/username/reponame.git

Then run the folling commands to install all dependancies

$ bower install
$ npm install

That's it, now you can continue on with a project as before.

Additional Notes

Proposed Directory Structure:

project_name
|--- node_modules *
|--- public (or public_html)
    |--- assets
        |--- js
            |--- source
            |--- min *
            |--- lib
            |--- vendor *
        |--- css *
        |--- images
|--- scss
|   .bowerrc
|   bower.json
|   flightplan.js
|   gitignore
|   gulfile.js
|   package.json
|	readme.md

* Added to .gitignore as Minified css/js, vendor packages and node modules do not need to be tracked.

Packages to add to selection list:

- Modernizr
- Selectivizr
- LoDash

... PLEASE MAKE SUGGESTIONS FOR ANYTHING ELSE YOU WOULD LIKE ADDED