added comments in chronos_npm_package, docker example, gRPC examples

Author: beezoo10

README.md

@@ -92,7 +92,7 @@ export DISPLAY="`sed -n 's/nameserver //p' /etc/resolv.conf`:0"
 ### Packing the Chronos App into an Executable
 
 1. From the root directory, run `npm run build`
-2. Run `npm package`
+2. Run `npm run package`
 3. Find the `chronos.app` executable inside the newly created `release-builds` folder in the root directory.
 
 #

chronos_npm_package/controllers/mongo.js

@@ -131,7 +131,7 @@ mongo.health = async ({ microservice, interval, mode }) => {
 };
 
 /**
- * Runs instead of health if dockerized is true
+ * !Runs instead of health if dockerized is true
  * Collects information on the docker container
  */
 mongo.docker = ({ microservice, interval, mode }) => {

chronos_npm_package/controllers/postgres.js

@@ -221,7 +221,7 @@ postgres.health = async ({ microservice, interval, mode }) => {
 };
 
 /**
- * Runs instead of health
+ * !Runs instead of health for docker
  * If dockerized is true, this function is invoked
  * Collects information on the container
  */

examples/docker/books/BookServer.js

@@ -4,6 +4,7 @@ const cors = require('cors');
 const controller = require('./BookController.js');
 
 const chronosConfig = require('./chronos-config.js');
+// follow directions in chronos_npm_tracker README - this downloads an npm package that a previous iteration made
 const Chronos = require('@chronosmicro/tracker');
 const chronos = new Chronos(chronosConfig);
 

examples/gRPC/reverse_proxy/index.js

@@ -33,7 +33,7 @@ const addBook = () => {
         display.appendChild(listItem);
       })
       .catch(err => {
-        console.log(err);
+        console.log("error in the addBook method: ", err);
       });
   }
 };

examples/gRPC/reverse_proxy/reverseProxyServer.js

@@ -2,6 +2,7 @@ const PORT = 3000;
 const express = require('express');
 const path = require('path');
 const grpc = require('@grpc/grpc-js');
+// uuid creates unqiue identifiers
 const { v4: uuidv4 } = require('uuid');
 const Chronos = require('@chronosmicro/tracker');
 const chronosConfig = require('./chronos-config');
@@ -10,6 +11,7 @@ require('./chronos-config');
 
 chronos.track();
 const app = express();
+// requiring in the clients used for this reverse proxy server
 const orderClient = require('./orderClient.js');
 const bookClient = require('./bookClient.js');
 
@@ -18,6 +20,7 @@ app.use(express.json());
 
 app.use(express.static(path.join(__dirname)));
 
+// HTML file to serve upon accessing PORT 3000
 app.get('/', (req, res, next) => {
   res.sendFile(path.join(__dirname, './index.html'));
 });