StreamBuilder

What it is

StreamBuilder is an automated build environment well suited for HTML, CSS and JavaScript prototyping. It runs on the (streaming) build system Gulp and comes with goodies like the SASS CSS extension language and the Nunjucks template language.

What it does

By working in the /src directory all of your changes are piped and rendered to the /dist folder.
    /src/scss -> /dist/css
    /src/js -> /dist/js
    /src/pages -> /dist/
    /src/img -> /dist/img

It even refreshes your browser on every change!

Requirements

Requires Nodejs

Getting Started

  1. Download or clone this repo to your development environment.
  2. From a terminal cd path/to/streambuilder
  3. Install the node modules listed in the package.json file. sudo npm install [node_module]
  4. Note: you might want to install gulp as a global application sudo npm install -g gulp for Gulp to be visible in your command line.
  5. Edit the paths variable in the gulpfile.js file to reflect your src and dist paths as well as your application URL.
  6. Run gulp

Production mode

By default StreamBuilder runs in development mode and outputs uncompressed CSS and JavaScript. To output compressed files you can run StreamBuilder in production mode. gulp production Production mode will not start a server nor will it watch for any changes.

Advanced configuration

You can change anything and everything about StreamBuilder by editing the gulpfile.js. By default StreamBuilder compiles everything to the /dist folder. You can chage this behavior (as well as the URL of the project) by editing the paths vars in the top of gulpfile.js.

StreamBuilder comes bundled with SASS and Nunjucks support. You can change this by removing the gulp-scss modules and installing the css pre-processor and template language of your choice then editing the tasks in gulpfile.js. You can find additional modules at NPM.

Goodies

Instructions for the mixins are in the /src/scss/components/_mixins.scss file. And examples are included in the src/scss/app.scss and /src/pages/index.njk files.

Getting Help

If you find a bug or want to see a feature, file it in the issues section.