StreamBuilder focuses on four tasks to make your job easier.
- Compile SCSS into minified CSS.
- Refresh your browser for you as you make changes to your source files. StreamBuilder will create a proxy server and listen on port 3000 of your localhost environment (example: http://localhost:3000/StreamBuilder/dist).
##Requirements Requires Nodejs
Note: if you run GNU/Linux you can now get the most recent version of Node with your package manager.
- Download this repo to your development environment.
- Install the node modules listed in the package.json file globally. I.e.,
sudo npm install -g <node_module>
- From a terminal
npm updateThis will create a new directory "node_modules" where NPM will install all the required node modules.
- Edit the config.json file to reflect your destination URL.
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
conf_xyz_dest vars in the top of gulpfile.js.
StreamBuilder comes bundles with SCSS 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 Out of the box StreamBuilder will create a single page website.
##Getting Help If you find a bug or want to see a feature, file it in the issues section.