Skip to content

Latest commit

 

History

History
40 lines (33 loc) · 1.7 KB

README.md

File metadata and controls

40 lines (33 loc) · 1.7 KB
Raw

Project template for gulp.js

What it does

  • Bundles all JavaScript with browserify
  • Minifies HTML and CSS
  • 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:koodiklinikka/gulp-project-template.git <your project name>
 cd <your project name>
 npm install
 npm start
 open http://localhost:9001 in your browser

Enable LiveReload

Install LiveReload for Chrome

CLI 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 test
    • Runs all tests
  • npm run build
    • Builds everything

Minification, uglification and other tasks you're expected to run before deploying your product can be made by running the build command with env variable NODE_ENV set to "production"

NODE_ENV=production npm run build

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 deletion.
  • All development dependencies should be installed with npm. Browser dependencies should be installed with bower or with npm.