node package manager

squareboy

squareboy

Pre-Requisites

$ npm install -g squareboy
$ squareboy run --recipe <folder>

About

Gulp tasks for,

  • static websites
  • single page applications
    • A special case of single page apps where everything is inlined

Valid options are,

--help
--dist # minification
--watch
--serve
--port
--recipe

gulp are,

  • html: Make html pages like jekyll

  • single-page-inline: Inline content and data folders as variables. Avoid css/js roundtrips.

  • single-page: Make content and data folders into json files.

  • freeze-js: Browserify

  • freeze-css Lessify

  • clean: Remove generated js and css

  • watch: Autocompile for dev mode.

  • mkdist: Copies font, img, icons folders

  • main: Freeze-css and freeze-js

  • default: Cleans and then runs --task

  • run: Useful defaults.

    port = args.port || "8080" watch = true serve = true; task = "single-page-inline" || args.task recipe = "recipe" || args.recipe

Workflow

Make a recipe with the following structure,

config.yaml
content # md, .txt
css #.less, .css
data # .csv, .json, .yaml
fonts
img
js
templates # .mustache

Run,

$ gulp run

This serves your files at http://127.0.0.1:8080.

config.yaml is available for templates to use.

Customization

Checkout tasks. Inspired from https://github.com/greypants/gulp-starter.

Live Reload

See http://tin.cr/

TODO

  • Abstract away paths

Contributers

  • Priyatam Mudivarti

Status

Experimental.