Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
tree: 112eeaa84e
Fetching contributors…

Cannot retrieve contributors at this time

113 lines (72 sloc) 3.388 kb

Welcome, Friend!

What am I?

Yeoman is a robust and opinionated client-side stack, comprised of tools and frameworks that can help developers quickly build beautiful web applications. We take care of providing everything needed to get started without any of the normal headaches associated with a manual setup.

Yeoman is fast, performant and is optimized to work best in modern browsers.

For more information about the project, see yeoman.io.

Installing

  • Clone this repo and cd into it
  • Run this command: ./setup/install.sh
  • Navigate to a new directory and run yeoman init to make sure everything is working as expected.

Trouble-shooting

If for any reason you experience exceptions after the yeoman installation process above, you may find the following steps resolve these issues:

$ cd yeoman/cli
$ sudo -s 'npm install -g && npm link'

Running

Here's a small shell script that you can save as server.sh which opens and serves the current directory:

#!/usr/bin/env sh

port=$1
if [ $# -ne 1 ]; then
  port=8000
fi

if [ $(uname -s) == "Darwin" ]; then
  open=open
else
  open=xdg-open
fi

$open http://localhost:$port && python -m SimpleHTTPServer $port;

You then need to make it executable: $ chmod +x server.sh

For example, run this guy as $ server (defaults to port 8000), or supply a port yourself $ server 3000.

Documentation

The current documentation for Yeoman can be found here. If you are a new contributor and require access to this repository, feel free to ask.

Browser Support

  • Modern browsers (latest version of Chrome, Safari, Firefox, Opera and IE10)
  • Chrome on Android
  • Mobile Safari

Platform Support

Yeoman 1.0 will support Mac OS X and will attempt to support Linux as well. We will be aiming to bring in support for Windows in a future version of the project.

Contribute

Repos

Style Guide

This project follows the jQuery Style Guide with an exception of two space indentation and multiple var statements. Please ensure any pull requests follow this closely. If you notice existing code which doesn't follow these practices, feel free to shout and we will address this.

About

Yeoman is an open-source project by Google which builds on top of Grunt and node-build-script. We utilize a number of useful open-source solutions including:

  • Twitter Bootstrap
  • HTML5 Boilerplate
  • Modernizr
  • Twitter Bower
  • Node.js
  • NPM
  • Compass
  • Socket.IO
  • CoffeeScript
  • Mocha
  • Jasmine
  • PhantomJS
  • And more...

Version 1 of the project features the combined efforts of:

and other developers.

We will be aiming to officially release the project in late July, 2012.

Jump to Line
Something went wrong with that request. Please try again.