mirror of
https://github.com/koodiklinikka/koodiklinikka.fi.git
synced 2026-02-06 10:57:55 +00:00
fdeceb8415eb2266c874d80a2b0e7ee0ff0b0c22
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
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 gulp-browserify config. Your compiler config should be something like this:
compileCoffee = (debug = false) ->
config =
debug: debug
transform: ['coffeeify']
shim:
jquery:
path: './vendor/jquery/jquery.js'
exports: '$'
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.
Enable LiveReload
Install LiveReload for Chrome
Description
Languages
TypeScript
86%
CSS
12.2%
JavaScript
1.8%