#eHouse Studio Project Starter A front-end project starter.
###Dependencies:
Node: Run $ node -v
to see if Node is installed. If Node is not installed, visit nodejs.org and then click that big green "Install" button.
###Installation:
- Clone Project Starter -
$ git clone https://github.com/ehousestudio/project-starter.git ProjectName
$ cd ProjectName
- Run
$ npm install
to install the NPM packages. - Run
$ bower install
to install all the Bower packages. If you get an error, it's probably because Bower wants to be installed globally. Run$ npm install -g bower
to take care of that. - You can now run any of the Gulp tasks manually (i.e.
$ gulp sass
or$ gulp scripts
). - In order to get BrowserSync working properly, add a proxy URL value at line 94 of
gulpfile.js
. Add a path to your HTML/template files at line 99 (this accepts an array so you can pass multiple paths). Once these are updated$ gulp serve
will work.
###Usage (Tasks):
$ gulp scripts
- Concatenates and minifies everything from src/scripts
to public/scripts
$ gulp images
- Minifies PNG, JPEG, GIF and SVG images in public/images
and saves to same dir
$ gulp sass
- Compiles Sass and creates source map while outputting to public/css
$ gulp pretty
- Runs through all the Sass files and cleans them up with proper indenting
$ gulp bower
- Runs through all the Bower dependencies and concatenates all the files and outputs to src/scripts/_vendor.js
$ gulp serve
- Watches for changes by default on src/sass
and src/scripts
directories (additional watch paths can be added as indicated in installation step 6)