Adds initial gulp workflow, page content, stylesheet & markdown docs

Author: d13

.gitignore

@@ -35,3 +35,7 @@ jspm_packages
 
 # Optional REPL history
 .node_repl_history
+
+# Idea
+.idea
+*.iml

README.md

@@ -1,2 +1,35 @@
 # d13.github.io
-my website
+
+My personal website and general dumping ground to try out my ideas.
+
+## Local Setup
+
+You will need node.js installed to run this locally and build the files.
+
+To get started:
+- From the terminal, browse to the project's root folder 
+- Run `npm install`
+
+
+## Development gulp task
+
+Run `gulp dev`
+
+This will:
+- Builds the JS, CSS and HTML files
+- Run a local web-server to see you changes
+- Live-reloads the browser as changes are made
+
+## Individual gulp tasks
+
+**Browsing locally:** run `gulp serve`
+
+**Wipe-out built files:** run `gulp clean`
+
+**Building all files:** run `gulp build`
+
+**Building HTML:** run `gulp build-templates`
+
+**Building JS:** run `gulp build-scripts`
+
+**Building CSS:** run `gulp build-styles`

assets/styles.css

@@ -0,0 +1,3 @@
+module.exports = {
+    env: ''
+};

build/gulp-context.js

@@ -0,0 +1,10 @@
+var appRoot = 'src/';
+var outputRoot = 'assets/';
+
+module.exports = {
+    root: appRoot,
+    scripts: appRoot + 'scripts/**/*.js',
+    templates: appRoot + 'templates/**/*.html',
+    styles: appRoot + 'styles/**/*.scss',
+    output: outputRoot
+};

build/paths.js

@@ -0,0 +1,65 @@
+var paths = require('../paths');
+var context = require('../gulp-context');
+
+var runSequence = require('run-sequence');
+
+var gulp = require('gulp');
+var changed = require('gulp-changed');
+var plumber = require('gulp-plumber');
+var notify = require('gulp-notify');
+var sourcemaps = require('gulp-sourcemaps');
+var autoprefixer = require('gulp-autoprefixer');
+var sass = require('gulp-sass');
+
+gulp.task('build-scripts', function () {
+    // TODO: add script build
+});
+
+gulp.task('build-templates', function () {
+    // TODO: add template build
+});
+
+var reportError = function (error) {
+    notify({
+        title: 'Gulp Task Error',
+        message: 'Check the console.'
+    }).write(error);
+
+    console.log(error.toString());
+
+    // Explicitely exit the stream, which gracefully kicks out of the task, letting watch survive
+    this.emit('end');
+    if (context.env !== 'watch') {
+        return process.exit(2);
+    }
+};
+
+gulp.task('build-styles', function () {
+    return gulp.src(paths.styles)
+        .pipe(plumber({errorHandler: reportError}))
+        .pipe(changed(paths.output, {extension: '.css'}))
+        .pipe(sourcemaps.init())
+        .pipe(sass())
+        .pipe(sourcemaps.write())
+        .pipe(autoprefixer({
+            browsers: ['last 2 versions', '> 5%', 'Firefox ESR']
+        }))
+        .pipe(gulp.dest(paths.output));
+});
+
+gulp.task('build', function (callback) {
+    return runSequence(
+        'clean',
+        ['build-scripts', 'build-templates', 'build-styles'],
+        function (err) {
+            if (err) {
+                var exitCode = 2;
+                console.log('[ERROR] gulp build task failed', err);
+                console.log('[FAIL] gulp build task failed - exiting with code ' + exitCode);
+                return process.exit(exitCode);
+            } else {
+                return callback();
+            }
+        }
+    );
+});

build/tasks/build.js

@@ -0,0 +1,10 @@
+var gulp = require('gulp');
+var paths = require('../paths');
+var del = require('del');
+var vinylPaths = require('vinyl-paths');
+
+// deletes all files in the output path
+gulp.task('clean', function () {
+    return gulp.src([paths.output])
+        .pipe(vinylPaths(del));
+});

build/tasks/clean.js

@@ -0,0 +1,28 @@
+var paths = require('../paths');
+
+var gulp = require('gulp');
+var browserSync = require('browser-sync').create();
+
+// this task utilizes the browsersync plugin
+// to create a dev server instance
+// at http://localhost:9000
+gulp.task('serve', ['build'], function (done) {
+    browserSync.init({
+        online: false,
+        open: false,
+        port: 9000,
+        server: {
+            baseDir: ['.'],
+            middleware: function (req, res, next) {
+                res.setHeader('Access-Control-Allow-Origin', '*');
+                next();
+            }
+        }
+    }, done);
+});
+
+gulp.task('dev', ['serve'], function () {
+    gulp.watch(paths.scripts, ['build-scripts']).on('change', browserSync.reload);
+    gulp.watch(paths.styles, ['build-styles']).on('change', browserSync.reload);
+    gulp.watch(paths.templates, ['build-templates']).on('change', browserSync.reload);
+});

build/tasks/serve.js

@@ -0,0 +1 @@
+require('require-dir')('build/tasks');