Fixing up the remaning issues with some comments

Matt Gaunt · Matt Gaunt · commit 42aa83da1f57 · 2015-10-23T12:36:32.000+01:00
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "app-shell",
-  "version": "0.1.148",
+  "version": "0.1.150",
   "private": true,
   "license": "Apache",
   "engines": {
diff --git a/server/app.js b/server/app.js
@@ -1,5 +1,16 @@
 'use strict';
 
+/**
+ *
+ * The structure of this node server is the following:
+ * 1.) server-controller starts an express server which defines the static
+ *     content, port number and sets up handle bars to use the views and layouts
+ * 2.) URLs are then routed by defining a url and calling addEndpoint(). On
+ *     requests to a matching url the onRequest() method is called in the
+ *     passed in controller (i.e. StaticPageController)
+ *
+ */
+
 var serverController = require('./controllers/server-controller');
 var StaticPageController = require('./controllers/static-page-controller');
 
diff --git a/server/controllers/server-controller.js b/server/controllers/server-controller.js
@@ -16,34 +16,24 @@ function ServerController() {
 }
 
 ServerController.prototype.setUpServer = function(app) {
+  // Set up the use of handle bars and set the path for views and layouts
   app.set('views', path.join(__dirname, '/../views'));
   app.engine('handlebars', exphbs({
     defaultLayout: 'default',
     layoutsDir: path.join(__dirname, '/../layouts')
   }));
   app.set('view engine', 'handlebars');
 
-  // Should be set POST login auth
-  app.use('/manifest.json',
-    express.static(path.join(__dirname + '/../../dist/manifest.json')));
-  app.use('/favicon.ico',
-    express.static(path.join(__dirname + '/../../dist/favicon.ico')));
-  app.use('/sw.js',
-    express.static(path.join(__dirname + '/../../dist/scripts/sw.js')));
-  app.use('/styles',
-    express.static(path.join(__dirname + '/../../dist/styles')));
-  app.use('/images',
-    express.static(path.join(__dirname + '/../../dist/images')));
-  app.use('/scripts',
-    express.static(path.join(__dirname + '/../../dist/scripts')));
-  app.use('/third_party',
-    express.static(path.join(__dirname + '/../../dist/third_party')));
+  // Define static assets path - i.e. styles, scripts etc.
+  app.use('/',
+    express.static(path.join(__dirname + '/../../dist/')));
 
   console.log('Starting server on 3123');
   return app.listen('3123');
 };
 
 ServerController.prototype.addEndpoint = function(endpoint, controller) {
+  // Add the endpoint and call the onRequest method when a request is made
   this.getExpressApp().get(endpoint, function(req, res) {
     controller.onRequest(req, res);
   });
diff --git a/server/controllers/static-page-controller.js b/server/controllers/static-page-controller.js
@@ -12,13 +12,17 @@ function prepareData(config) {
   var flattenedStyles = '';
   var pathPrefix = '/../../dist/';
   config.inlineStyles.forEach(function(file) {
-    flattenedStyles += fs.readFileSync(path.resolve(__dirname) + pathPrefix + file);
+    flattenedStyles += fs.readFileSync(path.resolve(__dirname) +
+      pathPrefix + file);
   });
+
   // Replace array with flattened string of content
   config.inlineStyles = flattenedStyles;
   return config;
-};
+}
 
+// This method looks at the request path and renders the appropriate handlebars
+// template
 StaticPageController.prototype.onRequest = function(req, res) {
   switch (req.path) {
   case '/':
diff --git a/server/layouts/default.handlebars b/server/layouts/default.handlebars
@@ -11,7 +11,7 @@
     <link rel="manifest" href="/manifest.json">
     <link rel="icon" href="/images/chrome-touch-icon-192x192.png" sizes="192x192" type="image/png">
 
-    <style>{{{inlineStyles}}}</style>
+    <style type="text/css">{{{inlineStyles}}}</style>
 </head>
 <body>
 
diff --git a/src/html/index.html b/src/html/index.html
diff --git a/src/sw.es6.js b/src/sw.es6.js

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "app-shell",`
`3`		`- "version": "0.1.148",`
	`3`	`+ "version": "0.1.150",`
`4`	`4`	`"private": true,`
`5`	`5`	`"license": "Apache",`
`6`	`6`	`"engines": {`