pho-devstack/README.md

Automated workflow for front-end developers in one tasty bowl of code

<p align="center">
  <a href="http://pho.madebysource.com">
    <img width="314" height="252" src="http://pho.madebysource.com/images/logo-big.png?"/>
  </a>
</p>

# Phở Devstack [![NPM version][npm-image]][npm-url]

> Automated workflow for front-end developers in one tasty bowl of code.

## Features

- Yeoman [generator](https://github.com/madebysource/generator-pho)
- Livereload (without browser reload for CSS)
- Sass and Less stylesheets compilation
- HTML, JavaScript and CSS minification
- Advanced image handling (base64 inlining, image optimization, sprite generation)
- Browserify modules (written in JavaScript or CoffeeScript)
- Linting JavaScript
- Running unit and end to end tests
- Configurable directory structure
- Replacing text in HTML (meta tags, analytics codes)
- Scripts and stylesheets revisioning
- Running build after file is changed
- Configurable plugins
- Stays up-to-date

## Installation

Run ```npm install -g gulp yo generator-pho```

*Phở Devstack uses [Gulp][Gulp] as task runner, [Yeoman][Yeoman] for scaffolding new projects and [Bower][Bower] for installing client-side packages.*

*Learn more about installing Phở at [Getting Started guide](docs/getting-started.md)*

## Documentation

For a Getting Started guide, FAQ, etc. see [documentation](docs/README.md).

## Status

This software should be stable. We've used it in [Source][Source] for all new landing pages and in [abdoc][Abdoc] for all new client projects since February 2014. We're currently working mainly on documentation.

## Want to contribute?

See our [Contributing guide](CONTRIBUTING.md)

## License

[MIT license](http://opensource.org/licenses/mit-license.php)

[npm-url]:  https://npmjs.org/package/pho-devstack
[npm-image]: http://img.shields.io/npm/v/pho-devstack.svg?style=flat

[Gulp]: http://gulpjs.com/
[Yeoman]: http://yeoman.io/
[Bower]: http://bower.io/
[Source]: https://madebysource.com/
[Abdoc]: http://abdoc.net/