You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,18 +1,18 @@
1
1
# StreamBuilder
2
2
3
3
##What it is
4
-
StreamBuilder is an automated build environment well suited for HTML, CSS and JavaScript prototyping. It runs on the (streaming) build system gulp.js. Also included is the Sass CSS extension language.
4
+
StreamBuilder is an automated build environment well suited for HTML, CSS and JavaScript prototyping. It runs on the (streaming) build system [Gulp.js](https://gulpjs.com/) and comes with goodies like [SASS](https://sass-lang.com/) and [Nunjucks](https://mozilla.github.io/nunjucks/).
5
5
6
6
*__StreamBuilder focuses on four tasks to make your job easier.__*
7
7
8
-
1. Compile SCSS into minified CSS.
9
-
2.Minify JavaScript.
10
-
3.Move your html/css/JavaScripts and images from the source (working) folder, to the destination folder.
11
-
4.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).
8
+
1. Compile SCSS into CSS and outpu to the destination folder.
9
+
2.Output JavaScript to the destination folder.
10
+
3.Compile Nunjuck templates into HTML pages and output them to the pages folder. Keepin' it DRY!
11
+
4.In your browser, inject the changed CSS into the HTML and update your view.
12
12
13
13
*__StreamBuilder's workflow__*
14
14
15
-
You work from the /src directory and everytime you save a file; be it SCSS, JavaScript or html templates, StreamBuilder compiles SCSS into CSS, minifies JavaScripts and places the compiled files in the /dist directory.
15
+
You work from the /src directory and everytime you save a file; be it SCSS, JavaScript or Nunjuck template, StreamBuilder compiles SCSS into CSS, and places compiled JavaScripts and HTML files in the /dist directory.
16
16
17
17
##Requirements
18
18
Requires [Nodejs](https://nodejs.org/)
@@ -25,12 +25,12 @@ Note: if you run GNU/Linux you can now get the most recent version of Node with
25
25
3. From a terminal `cd path/to/streambuilder`
26
26
4.`npm update` This will create a new directory "node_modules" where NPM will install all the required node modules.
27
27
5. Edit the config.json file to reflect your destination URL.
28
-
5. Run `gulp`
28
+
6. Run `gulp`
29
29
30
30
## Advanced configuration
31
31
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.
32
32
33
-
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](https://www.npmjs.com/).
33
+
StreamBuilder comes bundles with SCSS 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](https://www.npmjs.com/).
34
34
35
35
##Goodies
36
36
Out of the box StreamBuilder will create a single page website.
0 commit comments