Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Yeoman generator for Zurb Foundation based projects
JavaScript Ruby
Branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
foundation/all
.npmignore
LICENSE
README.md
install.js
package.json
uninstall.js

README.md

yeoman-foundation

This is a yeoman generator that scaffolds out a project using Zurb Foundation by default, expanding on yeoman's quickstart generator. This generator will install Zurb Foundation, jQuery, Backbone.js, Underscore.js, and Require.js.

Requirements

You will need the zurb-foundation compass gem installed. Visit the foundation documentation for detailed directions on installation. If you already have your ruby environment setup, all you need to do for installation is:

[sudo] gem install zurb-foundation

Installation

You can install this generator globally via npm:

[sudo] npm install -g yeoman-foundation

I have only tested this on Mac OS X, but it should work in Windows and other *nix environments. During a global npm install, the generator will get installed in your global node_modules directory, while a symlink to the foundation generator will be created in your global yeoman generators directory:

/usr/local/lib/node_modules/yeoman/node_modules/yeoman-generators/lib/generators/foundation/

Usage

After copying to your global generator location, use:

yeoman init foundation

to generate the basic scaffolding for a foundation based project.

This generator provides a scaffold that uses require.js to load javascript modules. After generating the project scaffolding a node child_process will run to install jQuery, Backbone, and Require.js along with any dependencies. This child process is running yeoman install jquery backbone requirejs --save so you don't have to after.

Note: There is a bug in Yeoman 0.9.6 that is preventing the --save argument from adding files to component.json. If you would like your components saved in there, run: bower install jquery backbone requirejs --save to add them.

Something went wrong with that request. Please try again.