Project template for gulp.js

What it does

Jade files to HTML
Stylus files to CSS
CoffeeScript files to Javascript through browserify
- You are able to use 'require' in your client-side code
Serves your static files to localhost:9001
Reloads your browser with LiveReload when files change

Getting things up and running

git clone git@github.com:leonidas/gulp-project-template.git <your project name>
cd <your project name>
npm install
npm start
open http://localhost:9001 in your browser

Commands

npm install
- Installs server-side dependencies from NPM and client-side dependencies from Bower
npm start
- Compiles your files, starts watching files for changes, serves static files to port 9001
npm run build
- Builds & minifies everything

Adding 3rd party libraries

bower install jquery --save

Now to use jQuery in your frontend code, you'll need to add jQuery to "browser" and "browserify-shim" sections of your package.json. Your package.json should be something like this:

...

"browser": {
  "jquery": "./vendor/jquery/dist/jquery.js"
},
"browserify-shim": {
  "jquery": "$"
},
"browserify": {
  "transform": [ "coffeeify", "browserify-shim" ]
}
...

Now your should be able to require jQuery in your coffee files

$ = require 'jquery'

Development guidelines

public - directory should be dedicated only to compiled/copied files from src - directory. It should be possible to delete directory completely and after npm start or npm run build everything should be as they were before the deletation.
All backend dependencies should be installed with npm. Browser dependencies should be installed with bower.

Enable LiveReload

Install LiveReload for Chrome

2.0 KiB Raw Blame History