update readme, phase 1

.gitignore

@@ -1,3 +1,5 @@
 hackathon.sublime-project
 hackathon.sublime-workspace
-node_modules
+node_modules
+.sass-cache/
+**/.DS_Store

README.md

@@ -0,0 +1,36 @@
+An step by step live demo to explain how the Oauth2 dance works in the ORCID API and how to use the access tokens to edit an ORCID record.
+
+#### Install NodeJS or Upgrade 
+
+[Install it!](https://nodejs.org/)
+or 
+[Upgrade it!](http://davidwalsh.name/upgrade-nodejs)
+if the version if less then 0.12.0
+
+### Install Gulp
+
+```
+sudo npm install --global gulp 
+```
+
+### Install dependencies
+
+```
+npm install 
+```
+
+### Run gulp, includes express web server
+
+```
+gulp
+```
+
+Source JavaScript and SCSS files are under /src folder, do not modify files that are in (/public/gulp_derived)
+
+### Production minimize mode
+The default view doesn't reference minimized js and css to make development easier. To enable css and javascript minimization 
+for production set the `MINIMIZE` environment variable to `true`;
+
+```
+export MINIMIZE=true
+```

gulpfile.js

@@ -5,31 +5,53 @@ var gulp = require('gulp'),
     uglify = require('gulp-uglify'),
     rename = require('gulp-rename'),
     concat = require('gulp-concat'),
+    nodemon = require('gulp-nodemon'),
     notify = require('gulp-notify'),
     cache = require('gulp-cache'),
     livereload = require('gulp-livereload'),
     plumber = require('gulp-plumber');
 
+
+// run livereload
+gulp.task('livereload', function() {
+    tinylr = require('tiny-lr')();
+    tinylr.listen(35729);
+});
+
+
+function notifyLiveReload(event) {
+    var fileName = require('path').relative(__dirname, event.path);
+
+    tinylr.changed({
+        body: {
+            files: [fileName]
+        }
+    });
+};
 
+
+// Styles gulp task
 gulp.task('styles', function () {
     return (sass('./src/scss'))
         .on('error', function (err) { console.log(err.message); })
         .pipe(plumber())
+        .pipe(gulp.dest('./public/gulp_derived/css'))
         .pipe(rename({ suffix: '.min' }))
         .pipe(minifycss())
-        .pipe(gulp.dest('./css'))
+        .pipe(gulp.dest('./public/gulp_derived/css'))
         .pipe(notify({ message: 'Styles task complete' }));
 });
 
+
 // Scripts
 gulp.task('scripts', function() {
   return gulp.src('./src/js/*.js')
     .pipe(plumber())
-    .pipe(concat('app.js'))
-    .pipe(gulp.dest('./js'))
+    .pipe(concat('client.js'))
+    .pipe(gulp.dest('./public/gulp_derived/js'))
     .pipe(rename({ suffix: '.min' }))
     .pipe(uglify())
-    .pipe(gulp.dest('./js'))
+    .pipe(gulp.dest('./public/gulp_derived/js'))
     .pipe(notify({ message: 'Custom Scripts task complete' }));
 });
 
@@ -38,17 +60,23 @@ gulp.task('scripts', function() {
 gulp.task('watch', function() {
   gulp.watch('./src/scss/*.scss', ['styles']);
   gulp.watch('./src/js/*.js', ['scripts']);
+  gulp.watch('./public/**', notifyLiveReload);
+  gulp.watch('./views/**', notifyLiveReload);
 });
 
-// Default task
-gulp.task('default', ['watch'], function() {
-    gulp.start('styles','scripts');
-});
-
-
-
-
-
-
 
+// run express
+gulp.task('express', function () {
+  nodemon({ script: 'server.js'
+          , ext: 'html js'
+          , ignore: ['ignored.js']
+          , tasks: ['lint'] })
+    .on('restart', function () {
+      console.log('restarted!')
+    })
+});
 
+// Default task
+gulp.task('default', ['express','livereload','watch'], function() {
+    gulp.start('styles','scripts');
+});

package.json

@@ -4,27 +4,39 @@
   "description": "A walkthrough page that will show you how the orcid api works and how you can interact with it",
   "main": "gulpfile.js",
   "dependencies": {
-    "gulp": "^3.8.11",
     "gulp-autoprefixer": "^2.2.0",
     "gulp-cache": "^0.2.9",
     "gulp-concat": "^2.5.2",
     "gulp-livereload": "^3.8.0",
     "gulp-minify-css": "^1.1.1",
     "gulp-notify": "^2.2.0",
+    "gulp-nodemon": "^2.0.3",
     "gulp-plumber": "^1.0.0",
     "gulp-ruby-sass": "^1.0.5",
     "gulp-rename": "^1.2.2",
     "gulp-uglify": "^1.2.0",
-    "gulp-jshint": "^1.10.0"
+    "ejs": "^1.0.0",
+    "nodelint": "^0.6.2",
+    "simple-oauth2": "https://github.com/ORCID/simple-oauth2/archive/MASTER_2015_06_03.tar.gz",
+	"body-parser": "^1.12.4"
+  },
+  "devDependencies": {
+    "connect-livereload": "^0.5.3",
+    "express": "^4.12.4",
+    "gulp": "^3.8.11",
+    "tiny-lr": "^0.1.5"
   },
-  "devDependencies": {},
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/hexplus/orcid-api-walkthrough.git"
   },
+  "engines": {
+    "node": ">= 0.12.0",
+    "npm": ">= 2.0.0"
+  },
   "keywords": [
     "orcid",
     "hackaton",
@@ -36,5 +48,6 @@
   "bugs": {
     "url": "https://github.com/hexplus/orcid-api-walkthrough/issues"
   },
-  "homepage": "https://github.com/hexplus/orcid-api-walkthrough#readme"
+  "homepage": "https://github.com/hexplus/orcid-api-walkthrough#readme",
+  "main": "server.js"
 }