README

Generator-grep

A web application tool powered by yeoman and gulp.

Get Started, Install Dependency Packages:

If you dont have node, then go to http://nodejs.org/

$ npm install -g yo
$ npm install -g bower
$ npm install -g gulp

Install Grep:

$ npm install -g generator-grep

First create a folder and cd into:

$ mkdir <folder-name> && cd $_

Create new application with:

$ yo grep <app-name> (or) yo grep

Everything is set, npm & bower will automatically install, if not:

$ npm install
$ bower install

Finally, type:

$ gulp

Folder Structure:

1. Copy all your existing files to app folder (or) create your own files in folder structure like below

    Everything inside app/ folder will automatically copies to build/ directory

    app/           (development dir)
      -js/         (js files)
      -js/lib/     (library files)
      -css/        (both sass and css files & import sass files to app.scss)
      -images/     (images)
      -fonts/      (fonts goes here)

      (if your app is using angular, then it will also have below struture)

      -js/controllers (all controllers files goes here)
      -js/services
      -js/factory
      -js/directives
      -js/filters
      -js/app.js

2. Enter gulp in terminal to see the magic.

Run following command:

1. gulp (development mode)
2. gulp prod (production mode) - To uglify and minify all JS, CSS & HTML files

Add library through bower:

bower install <lib-name> --save-dev

After installing new library, files will be automatically concat to bower.css & bower.js, no extra work needed.

Manually add library:

eg: modernizr.js

    app/
      -js/ (add .js files here)

Seperate gulp commands:

1. gulp<space>zip           -- To create a zip file of your build folder with date
2. gulp<space>html          -- To copy html files to build/
3. gulp<space>css           -- To convert sass to css and concat css files
4. gulp<space>scripts       -- To lint the errors in terminal and concat all js
5. gulp<space>img-min       -- To minify all image files
6. gulp<space>concat-bower  -- To concat all bower dependencies to a single file
7. gulp<space>watch         -- To watch all file changes and do all above tasks
8. gulp<space>browser-sync  -- To check responsiveness in all browser
9. gulp<space>server        -- To start a local server with live reload

Clean build & zip commands:

1.gulp<space>clean	-- To delete build folder

License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Usage no npm install needed!