From 246c8eef3ffe99031c0418c2bc086e0dee2dfe31 Mon Sep 17 00:00:00 2001
From: Peter Morgan <peter@1080peter.com>
Date: Sun, 29 Dec 2019 07:33:31 -0700
Subject: [PATCH 1/7] API Rework (#28)

API refactor
---
 routes/{api.js => api/v1.js} |   0
 routes/api/v2.js             | 310 +++++++++++++++++++++++++++++++++++
 routes/index.js              |   4 +-
 3 files changed, 312 insertions(+), 2 deletions(-)
 rename routes/{api.js => api/v1.js} (100%)
 create mode 100644 routes/api/v2.js

diff --git a/routes/api.js b/routes/api/v1.js
similarity index 100%
rename from routes/api.js
rename to routes/api/v1.js
diff --git a/routes/api/v2.js b/routes/api/v2.js
new file mode 100644
index 0000000..4e17a72
--- /dev/null
+++ b/routes/api/v2.js
@@ -0,0 +1,310 @@
+const routes = require('express').Router();
+const got = require("got");
+const cache = require('memory-cache');
+const dotenv = require("dotenv").config();
+const GITHUB_API = "https://api.github.com";
+const authenticate = `client_id=${process.env.CLIENT_ID}&client_secret=${process.env.CLIENT_SECRET}`;
+
+const API_FOLLOWING = "/following";
+const API_FOLLOWERS = "/followers";
+const API_USER_PATH = "/users/";
+const API_ORGS_PATH = "/orgs/";
+const API_PAGINATION_SIZE = 100; // 100 is the max, 30 is the default
+// if this is too large, it would be infeasible to make graphs for people following popular people
+const API_MAX_PAGES = 2;
+const API_PAGINATION = "&per_page=" + API_PAGINATION_SIZE;
+
+const REPOS_PATH = "/repos";
+
+
+/**
+ * Queries data from the github APi server and returns it as
+ * a json object in a promise.
+ * 
+ * This makes no attempt to cache
+ * 
+ * @param {*} requestURL endpoint on githubapi: ex: /users/jrtechs/following
+ */
+const queryGithubAPIRaw = async requestURL => {
+    let queryURL = requestURL.includes("?page=") ? `${GITHUB_API}${requestURL}&${authenticate}` :`${GITHUB_API}${requestURL}?${authenticate}`;
+    console.log(queryURL);
+    try {
+        const req = await got(queryURL, { json: true });
+        cache.put(requestURL, req);
+        return req;
+    } catch (error) {
+        console.log(error);
+        cache.put(requestURL, `${error.statusCode} - ${error.statusMessage}`);
+    }
+}
+
+
+/**
+ * Queries data from the github api server
+ * and caches the results locally.
+ * 
+ * @param {*} requestURL 
+ */
+const queryGitHubAPI = async requestURL => {
+    const apiData = cache.get(requestURL);
+    if (apiData) {
+        console.log("Fetched From Cache");
+        return apiData
+    }
+
+    try {
+        return await queryGithubAPIRaw(requestURL);
+    } catch (error) {
+        console.log(error);
+    }
+}
+
+
+/**
+ * Fetches all content from a particular github api endpoint
+ * using their pagination schema.
+ * 
+ * @param {*} username username of github client
+ * @param {*} apiPath following or followers
+ * @param {*} page current pagination page
+ * @param {*} lst list we are building on
+ */
+const fetchAllWithPagination = async (apiPath, page, lst) => {
+    try {
+        const req = await queryGithubAPIRaw(`${apiPath}?page=${page}${API_PAGINATION}`);
+        if (req.body.hasOwnProperty("length")) {
+            const list = lst.concat(req.body);
+            if(page < API_MAX_PAGES && req.length === API_PAGINATION_SIZE) {
+                const redo = await fetchAllWithPagination(apiPath, page + 1, list);
+                return redo;
+            }
+            return list;
+        }
+    } catch (error) {
+        console.log("Error with api request");
+    }
+}
+
+
+/**
+ * Makes a copy of a JS object with certain properties
+ * 
+ * @param {*} props 
+ * @param {*} obj 
+ */
+const copyWithProperties = (props, obj) => {
+    let newO = new Object();
+    props.forEach(prop => {
+        newO[prop] = obj[prop];
+    })
+    return newO;
+}
+
+
+/**
+ * Combines the list of friends and followers ignoring duplicates
+ * that are already in the list. (person is both following and followed by someone)
+ * 
+ * This also removes any unused properties like events_url and organizations_url
+ * 
+ * @param {*} followingAndFollowers 
+ */
+const minimizeFriends = people => {
+    let friendLst = [];
+    let ids = new Set();
+    people.forEach(person => {
+        if(!ids.has(person.id)) {
+            ids.add(person.id);
+            friendLst.push({
+                login: person.login, 
+                avatar_url: person.avatar_url
+            });
+        }
+    });
+    return friendLst;
+}
+
+
+/**
+ * Fetches all the people that are either following or is followed
+ * by a person on github. This will cache the results to make simultaneous
+ * connections easier and less demanding on the github API.
+ * 
+ * @param {*} user 
+ */
+const queryFriends = async user => {
+    const cacheHit = cache.get("/friends/" + user);
+    if (cacheHit){
+        console.log("Friends cache hit");
+        return cacheHit;
+    }
+
+    try {
+        const followers = await fetchAllWithPagination(API_USER_PATH + user + API_FOLLOWERS, 1, []);
+        const following = await fetchAllWithPagination(API_USER_PATH + user + API_FOLLOWING, 1, []);
+        const fList = minimizeFriends(following.concat(followers));
+        cache.put(`/friends/${user}`, fList);
+        return fList;
+    } catch (error) {
+        console.log("API Error", err); 
+    }
+}
+
+
+/**
+ * 
+ * Fetches all of the members of an organization from the
+ * API or cache
+ *
+ * /orgs/RITlug/members?page=1
+ *
+ * @param {*} orgName 
+ */
+const getOrganizationMembers = async orgName => {
+    const cacheHit = cache.get("/org/users/" + orgName);
+    if (cacheHit){
+        console.log("Org members cache hit");
+        return cacheHit;
+    }
+
+    try {
+        const members = await fetchAllWithPagination(API_ORGS_PATH + orgName + "/members", 1, []);
+        const membersMin = minimizeFriends(members);
+        cache.put("/org/users/" + orgName, membersMin);
+        return membersMin;
+    } catch (error) {
+        console.log(error);
+    }
+}
+
+
+/**
+ * Minimizes the JSON for a list of repositories
+ * 
+ * @param {*} repositories 
+ */
+const minimizeRepositories = repositories => {
+    let rList = [];
+    repositories.forEach(repo => {
+        rList.push(copyWithProperties(["name", "created_at", "homepage", 
+            "description", "language", "forks", "watchers",
+            "open_issues_count", "license", "html_url"],
+            repo));
+    })
+
+    return rList;
+}
+
+
+/**
+ * Fetches all repositories from the API
+ * 
+ * @param {*} user name of org/user
+ * @param {*} orgsOrUsers  either /users/ or /orgs/
+ */
+const queryRepositories = async (user, orgsOrUsers) => {
+    const cacheHit = cache.get(user + REPOS_PATH);
+    if (cacheHit) {
+        console.log("Repositories cache hit");
+        return cacheHit;
+    }
+
+    try {
+        const repos = await fetchAllWithPagination(orgsOrUsers + user + REPOS_PATH, 1, []);
+        const minRepos = minimizeRepositories(repos);
+        cache.put(`${user}${REPOS_PATH}`, minRepos);
+        return minRepos;
+    } catch (error) {
+        console.log(error)
+        console.log("bad things went down");
+    }
+}
+
+
+/**
+ * /users/name/following/followers
+ */
+routes.get("/friends/:name", async (req, res)=> {
+    try {
+        const query = await queryFriends(req.params.name);
+        res.json(query);
+    } catch (error) {
+        res.status(500).json({error: 'API error fetching friends'});
+    }
+});
+
+
+routes.get("/org/users/:name", async (request, res) => {
+    try {
+        const orgMembers = await getOrganizationMembers(request.params.name);
+        res.json(orgMembers).end();
+    } catch (error) {
+        res.status(500).json({error: 'API error fetching friends'}).end();
+    }
+});
+
+
+routes.get("/repositories/:name", async (req, res) => {
+    try {
+        const repos = await queryRepositories(req.params.name, API_USER_PATH);
+        res.json(repos).end();
+    } catch (error) {
+        res.status(500).json({error: 'API error fetching friends'}).end();
+    }
+});
+
+
+routes.get("/org/repositories/:name", async (req, res) => {
+    try {
+        const repos = await queryRepositories(req.params.name, API_ORGS_PATH);
+        res.json(repos).end();
+    } catch (error) {
+        res.status(500).json({error: 'API error fetching friends'}).end();
+    }
+});
+
+
+routes.get('/*', (request, result) =>
+{
+    var gitHubAPIURL = request.url;
+
+    result.setHeader('Content-Type', 'application/json');
+    queryGitHubAPI(gitHubAPIURL).then((data)=>
+    {
+        if(data.hasOwnProperty("id") || data[0].hasOwnProperty("id"))
+        {
+            result.write(JSON.stringify(data));
+        }
+        else
+        {
+            result.write("[]");
+        }
+        result.end();
+    }).catch((error)=>
+    {
+        try
+        {
+            if(error.hasOwnProperty("id") || error[0].hasOwnProperty("id"))
+            {
+                result.write(JSON.stringify(error));
+            }
+            else
+            {
+                result.write("[]");
+            }
+
+        }
+        catch(error) 
+        {
+            result.write("[]");
+        };
+        result.end();
+    });
+
+    if(cache.size() > 50000)
+    {
+        cache.clear();
+    }
+});
+
+module.exports = routes;
\ No newline at end of file
diff --git a/routes/index.js b/routes/index.js
index 4e8bd6d..67ab663 100644
--- a/routes/index.js
+++ b/routes/index.js
@@ -1,6 +1,6 @@
 const routes = require('express').Router();
-const api = require('./api');
-routes.use('/api', api);
+const apiV1 = require('./api/v1');
+routes.use('/api', apiV1);
 
 routes.get("/", (request, response) => {
     response.redirect("index.html");

From 08e332f1c8ac900ca34e2ee1dee2559d7b71fdb0 Mon Sep 17 00:00:00 2001
From: Peter Morgan <peter@1080peter.com>
Date: Tue, 31 Dec 2019 07:46:41 -0700
Subject: [PATCH 2/7] Updated readme.md with API reference (#32)

Updated readme.md with API reference
---
 README.md | 103 +++++++++++++++++++++++++++++++++++++++++++++++++++---
 1 file changed, 98 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 5282733..7c7908c 100644
--- a/README.md
+++ b/README.md
@@ -6,16 +6,14 @@ Website for visualizing a persons github network.
 
 If you are lucky, you can find the site live [here](https://github-graphs.com/);
 
-
 # Built With
 
 - [BootStrap](https://getbootstrap.com/)
 - [jQuery](https://jquery.com/)
 - [Vis JS](http://visjs.org/)
-- [Github v3 API](https://developer.github.com/v3/) 
+- [Github v3 API](https://developer.github.com/v3/)
 - [Node.js](https://nodejs.org/en/)
 
-
 ![javascript](./doc/javaScript.jpg)
 
 # Running
@@ -37,7 +35,102 @@ npm install
 node server.js
 ```
 
-
 # Contributing
 
-We are very open to new contributors. If you want to contribute to this project, and don't know where to start, look at the [open issues](https://github.com/jrtechs/github-graphs/issues). Once you know what you want to work on, comment on the issue and file a pull request. 
\ No newline at end of file
+We are very open to new contributors. If you want to contribute to this project, and don't know where to start, look at the [open issues](https://github.com/jrtechs/github-graphs/issues). Once you know what you want to work on, comment on the issue and file a pull request.
+
+# API Reference
+
+`GET https://github-graphs.com/api/friends/<username>`
+
+Fetches `https://api.github.com/users/<username>/followers` [(GitHub Reference)](https://developer.github.com/v3/users/followers/#list-followers-of-a-user) and `https://api.github.com/users/<username>/following` [(GitHub Reference)](https://developer.github.com/v3/users/followers/#list-users-followed-by-another-user) to generate an array of users following `<username>` and that `<username>` follows each with values `login` and `avatar_url`.
+
+Example result:
+
+```json
+[
+  {
+    "login": "jrtechs",
+    "avatar_url": "https://avatars1.githubusercontent.com/u/13894625?s=460&v=4"
+  }
+]
+```
+
+---
+
+`GET https://github-graphs.com/api/repositories/<username>`
+
+Fetches `https://api.github.com/users/<username>/repos` and returns an array of the repositories `<username>` owns.
+
+Example result:
+
+```json
+[
+  {
+    "name": "bash_manager",
+    "created_at": "2017-09-27T14:38:01Z",
+    "homepage": "",
+    "description": "Python scripts I use to manage my ssh connections, drive mounts, and other bash related things. ",
+    "language": "Python",
+    "forks": 26,
+    "watchers": 4,
+    "open_issues_count": 7,
+    "license": {
+      "key": "mpl-2.0",
+      "name": "Mozilla Public License 2.0",
+      "spdx_id": "MPL-2.0",
+      "url": "https://api.github.com/licenses/mpl-2.0",
+      "node_id": "MDc6TGljZW5zZTE0"
+    },
+    "html_url": "https://github.com/jrtechs/bash_manager"
+  }
+]
+```
+
+---
+
+`GET https://github-graphs.com/api/org/users/<organization_name>`
+
+Fetches `https://api.github.com/orgs/<organization_name>/members` [(GitHub Reference)](https://developer.github.com/v3/orgs/members/#members-list) to generate an array of users that are in `<organization_name>` each with values `login` and `avatar_url`.
+
+Example result:
+
+```json
+[
+  {
+    "login": "jrtechs",
+    "avatar_url": "https://avatars1.githubusercontent.com/u/13894625?s=460&v=4"
+  }
+]
+```
+
+---
+
+`GET https://github-graphs.com/api/org/repositories/<organization_name>`
+
+Fetches `https://api.github.com/orgs/<organization_name>/repos` [(GitHub Reference)](https://developer.github.com/v3/repos/#list-organization-repositories) to return an array of repositories `<organization_name>` owns.
+
+Example result:
+
+```json
+[
+  {
+    "name": "vue",
+    "created_at": "2013-07-29T03:24:51Z",
+    "homepage": "http://vuejs.org",
+    "description": "🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.",
+    "language": "JavaScript",
+    "forks": 23228,
+    "watchers": 154891,
+    "open_issues_count": 419,
+    "license": {
+      "key": "mit",
+      "name": "MIT License",
+      "spdx_id": "MIT",
+      "url": "https://api.github.com/licenses/mit",
+      "node_id": "MDc6TGljZW5zZTEz"
+    },
+    "html_url": "https://github.com/vuejs/vue"
+  }
+]
+```

From a232882774fdb412227932c43297ac164b89e97a Mon Sep 17 00:00:00 2001
From: Peter Morgan <peter@1080peter.com>
Date: Mon, 6 Jan 2020 07:25:16 -0700
Subject: [PATCH 3/7] Set up repo in preparation for front end rework (#33)

---
 .gitignore                                          |  10 +++++-----
 gitGraph.service => server/gitGraph.service         |   0
 package.json => server/package.json                 |   0
 {public => server/public}/404.html                  |   0
 {public => server/public}/FriendsGraph.html         |   0
 {public => server/public}/GraphGenerator.html       |   0
 {public => server/public}/GraphTest.html            |   0
 {public => server/public}/OrgRepoGraph.html         |   0
 {public => server/public}/TimeLineGraph.html        |   0
 {public => server/public}/about.html                |   0
 {public => server/public}/favicon.ico               | Bin
 {public => server/public}/fonts/Comfortaa-Bold.ttf  | Bin
 {public => server/public}/fonts/Comfortaa-Light.ttf | Bin
 .../public}/fonts/Comfortaa-Regular.ttf             | Bin
 .../public}/ico/baseline-bar_chart-24px.svg         |   0
 {public => server/public}/ico/graph.png             | Bin
 .../public}/ico/outline-timeline-24px.svg           |   0
 {public => server/public}/icon.svg                  |   0
 {public => server/public}/img/DolphinCroissant.png  | Bin
 {public => server/public}/img/email.svg             |   0
 {public => server/public}/img/friends.png           | Bin
 {public => server/public}/img/friends2.png          | Bin
 {public => server/public}/img/github-circle.svg     |   0
 {public => server/public}/img/githubgraph-logo.svg  |   0
 {public => server/public}/img/graphExample.png      | Bin
 {public => server/public}/img/home-image.png        | Bin
 {public => server/public}/img/linkedin-box.svg      |   0
 {public => server/public}/index.html                |   0
 {public => server/public}/js/createOrgInfo.js       |   0
 {public => server/public}/js/createOrgRepoGraph.js  |   0
 {public => server/public}/js/createOrgTable.js      |   0
 {public => server/public}/js/friendsGraph.js        |   0
 {public => server/public}/js/githubAPI.js           |   0
 {public => server/public}/js/profileGen.js          |   0
 {public => server/public}/js/profileTimeLine.js     |   0
 {public => server/public}/js/repoGen.js             |   0
 {public => server/public}/js/utilities.js           |   0
 .../public}/js/vis/img/network/acceptDeleteIcon.png | Bin
 .../public}/js/vis/img/network/addNodeIcon.png      | Bin
 .../public}/js/vis/img/network/backIcon.png         | Bin
 .../public}/js/vis/img/network/connectIcon.png      | Bin
 .../public}/js/vis/img/network/cross.png            | Bin
 .../public}/js/vis/img/network/cross2.png           | Bin
 .../public}/js/vis/img/network/deleteIcon.png       | Bin
 .../public}/js/vis/img/network/downArrow.png        | Bin
 .../public}/js/vis/img/network/editIcon.png         | Bin
 .../public}/js/vis/img/network/leftArrow.png        | Bin
 .../public}/js/vis/img/network/minus.png            | Bin
 .../public}/js/vis/img/network/plus.png             | Bin
 .../public}/js/vis/img/network/rightArrow.png       | Bin
 .../public}/js/vis/img/network/upArrow.png          | Bin
 .../public}/js/vis/img/network/zoomExtends.png      | Bin
 {public => server/public}/js/vis/vis-graph3d.min.js |   0
 .../public}/js/vis/vis-network.min.css              |   0
 {public => server/public}/js/vis/vis-network.min.js |   0
 .../public}/js/vis/vis-timeline-graph2d.min.css     |   0
 .../public}/js/vis/vis-timeline-graph2d.min.js      |   0
 {public => server/public}/js/vis/vis.css            |   0
 {public => server/public}/js/vis/vis.js             |   0
 {public => server/public}/js/vis/vis.js.map         |   0
 {public => server/public}/js/vis/vis.map            |   0
 {public => server/public}/js/vis/vis.min.css        |   0
 {public => server/public}/js/vis/vis.min.js         |   0
 {public => server/public}/logo.svg                  |   0
 {public => server/public}/style.css                 |   0
 {routes => server/routes}/api/v1.js                 |   0
 {routes => server/routes}/api/v2.js                 |   0
 {routes => server/routes}/index.js                  |   0
 run.sh => server/run.sh                             |   0
 server.js => server/server.js                       |   0
 70 files changed, 5 insertions(+), 5 deletions(-)
 rename gitGraph.service => server/gitGraph.service (100%)
 rename package.json => server/package.json (100%)
 rename {public => server/public}/404.html (100%)
 rename {public => server/public}/FriendsGraph.html (100%)
 rename {public => server/public}/GraphGenerator.html (100%)
 rename {public => server/public}/GraphTest.html (100%)
 rename {public => server/public}/OrgRepoGraph.html (100%)
 rename {public => server/public}/TimeLineGraph.html (100%)
 rename {public => server/public}/about.html (100%)
 rename {public => server/public}/favicon.ico (100%)
 rename {public => server/public}/fonts/Comfortaa-Bold.ttf (100%)
 rename {public => server/public}/fonts/Comfortaa-Light.ttf (100%)
 rename {public => server/public}/fonts/Comfortaa-Regular.ttf (100%)
 rename {public => server/public}/ico/baseline-bar_chart-24px.svg (100%)
 rename {public => server/public}/ico/graph.png (100%)
 rename {public => server/public}/ico/outline-timeline-24px.svg (100%)
 rename {public => server/public}/icon.svg (100%)
 rename {public => server/public}/img/DolphinCroissant.png (100%)
 rename {public => server/public}/img/email.svg (100%)
 rename {public => server/public}/img/friends.png (100%)
 rename {public => server/public}/img/friends2.png (100%)
 rename {public => server/public}/img/github-circle.svg (100%)
 rename {public => server/public}/img/githubgraph-logo.svg (100%)
 rename {public => server/public}/img/graphExample.png (100%)
 rename {public => server/public}/img/home-image.png (100%)
 rename {public => server/public}/img/linkedin-box.svg (100%)
 rename {public => server/public}/index.html (100%)
 rename {public => server/public}/js/createOrgInfo.js (100%)
 rename {public => server/public}/js/createOrgRepoGraph.js (100%)
 rename {public => server/public}/js/createOrgTable.js (100%)
 rename {public => server/public}/js/friendsGraph.js (100%)
 rename {public => server/public}/js/githubAPI.js (100%)
 rename {public => server/public}/js/profileGen.js (100%)
 rename {public => server/public}/js/profileTimeLine.js (100%)
 rename {public => server/public}/js/repoGen.js (100%)
 rename {public => server/public}/js/utilities.js (100%)
 rename {public => server/public}/js/vis/img/network/acceptDeleteIcon.png (100%)
 rename {public => server/public}/js/vis/img/network/addNodeIcon.png (100%)
 rename {public => server/public}/js/vis/img/network/backIcon.png (100%)
 rename {public => server/public}/js/vis/img/network/connectIcon.png (100%)
 rename {public => server/public}/js/vis/img/network/cross.png (100%)
 rename {public => server/public}/js/vis/img/network/cross2.png (100%)
 rename {public => server/public}/js/vis/img/network/deleteIcon.png (100%)
 rename {public => server/public}/js/vis/img/network/downArrow.png (100%)
 rename {public => server/public}/js/vis/img/network/editIcon.png (100%)
 rename {public => server/public}/js/vis/img/network/leftArrow.png (100%)
 rename {public => server/public}/js/vis/img/network/minus.png (100%)
 rename {public => server/public}/js/vis/img/network/plus.png (100%)
 rename {public => server/public}/js/vis/img/network/rightArrow.png (100%)
 rename {public => server/public}/js/vis/img/network/upArrow.png (100%)
 rename {public => server/public}/js/vis/img/network/zoomExtends.png (100%)
 rename {public => server/public}/js/vis/vis-graph3d.min.js (100%)
 rename {public => server/public}/js/vis/vis-network.min.css (100%)
 rename {public => server/public}/js/vis/vis-network.min.js (100%)
 rename {public => server/public}/js/vis/vis-timeline-graph2d.min.css (100%)
 rename {public => server/public}/js/vis/vis-timeline-graph2d.min.js (100%)
 rename {public => server/public}/js/vis/vis.css (100%)
 rename {public => server/public}/js/vis/vis.js (100%)
 rename {public => server/public}/js/vis/vis.js.map (100%)
 rename {public => server/public}/js/vis/vis.map (100%)
 rename {public => server/public}/js/vis/vis.min.css (100%)
 rename {public => server/public}/js/vis/vis.min.js (100%)
 rename {public => server/public}/logo.svg (100%)
 rename {public => server/public}/style.css (100%)
 rename {routes => server/routes}/api/v1.js (100%)
 rename {routes => server/routes}/api/v2.js (100%)
 rename {routes => server/routes}/index.js (100%)
 rename run.sh => server/run.sh (100%)
 rename server.js => server/server.js (100%)

diff --git a/.gitignore b/.gitignore
index f965bc5..ecc4832 100644
--- a/.gitignore
+++ b/.gitignore
@@ -2,8 +2,8 @@
 # This .gitignore file was automatically created by Microsoft(R) Visual Studio.
 ################################################################################
 
-/.vs
-/node_modules/.bin
-/node_modules
-/package-lock.json
-.env
\ No newline at end of file
+*/.vs
+*/node_modules/.bin
+*/node_modules
+*/package-lock.json
+*/.env
\ No newline at end of file
diff --git a/gitGraph.service b/server/gitGraph.service
similarity index 100%
rename from gitGraph.service
rename to server/gitGraph.service
diff --git a/package.json b/server/package.json
similarity index 100%
rename from package.json
rename to server/package.json
diff --git a/public/404.html b/server/public/404.html
similarity index 100%
rename from public/404.html
rename to server/public/404.html
diff --git a/public/FriendsGraph.html b/server/public/FriendsGraph.html
similarity index 100%
rename from public/FriendsGraph.html
rename to server/public/FriendsGraph.html
diff --git a/public/GraphGenerator.html b/server/public/GraphGenerator.html
similarity index 100%
rename from public/GraphGenerator.html
rename to server/public/GraphGenerator.html
diff --git a/public/GraphTest.html b/server/public/GraphTest.html
similarity index 100%
rename from public/GraphTest.html
rename to server/public/GraphTest.html
diff --git a/public/OrgRepoGraph.html b/server/public/OrgRepoGraph.html
similarity index 100%
rename from public/OrgRepoGraph.html
rename to server/public/OrgRepoGraph.html
diff --git a/public/TimeLineGraph.html b/server/public/TimeLineGraph.html
similarity index 100%
rename from public/TimeLineGraph.html
rename to server/public/TimeLineGraph.html
diff --git a/public/about.html b/server/public/about.html
similarity index 100%
rename from public/about.html
rename to server/public/about.html
diff --git a/public/favicon.ico b/server/public/favicon.ico
similarity index 100%
rename from public/favicon.ico
rename to server/public/favicon.ico
diff --git a/public/fonts/Comfortaa-Bold.ttf b/server/public/fonts/Comfortaa-Bold.ttf
similarity index 100%
rename from public/fonts/Comfortaa-Bold.ttf
rename to server/public/fonts/Comfortaa-Bold.ttf
diff --git a/public/fonts/Comfortaa-Light.ttf b/server/public/fonts/Comfortaa-Light.ttf
similarity index 100%
rename from public/fonts/Comfortaa-Light.ttf
rename to server/public/fonts/Comfortaa-Light.ttf
diff --git a/public/fonts/Comfortaa-Regular.ttf b/server/public/fonts/Comfortaa-Regular.ttf
similarity index 100%
rename from public/fonts/Comfortaa-Regular.ttf
rename to server/public/fonts/Comfortaa-Regular.ttf
diff --git a/public/ico/baseline-bar_chart-24px.svg b/server/public/ico/baseline-bar_chart-24px.svg
similarity index 100%
rename from public/ico/baseline-bar_chart-24px.svg
rename to server/public/ico/baseline-bar_chart-24px.svg
diff --git a/public/ico/graph.png b/server/public/ico/graph.png
similarity index 100%
rename from public/ico/graph.png
rename to server/public/ico/graph.png
diff --git a/public/ico/outline-timeline-24px.svg b/server/public/ico/outline-timeline-24px.svg
similarity index 100%
rename from public/ico/outline-timeline-24px.svg
rename to server/public/ico/outline-timeline-24px.svg
diff --git a/public/icon.svg b/server/public/icon.svg
similarity index 100%
rename from public/icon.svg
rename to server/public/icon.svg
diff --git a/public/img/DolphinCroissant.png b/server/public/img/DolphinCroissant.png
similarity index 100%
rename from public/img/DolphinCroissant.png
rename to server/public/img/DolphinCroissant.png
diff --git a/public/img/email.svg b/server/public/img/email.svg
similarity index 100%
rename from public/img/email.svg
rename to server/public/img/email.svg
diff --git a/public/img/friends.png b/server/public/img/friends.png
similarity index 100%
rename from public/img/friends.png
rename to server/public/img/friends.png
diff --git a/public/img/friends2.png b/server/public/img/friends2.png
similarity index 100%
rename from public/img/friends2.png
rename to server/public/img/friends2.png
diff --git a/public/img/github-circle.svg b/server/public/img/github-circle.svg
similarity index 100%
rename from public/img/github-circle.svg
rename to server/public/img/github-circle.svg
diff --git a/public/img/githubgraph-logo.svg b/server/public/img/githubgraph-logo.svg
similarity index 100%
rename from public/img/githubgraph-logo.svg
rename to server/public/img/githubgraph-logo.svg
diff --git a/public/img/graphExample.png b/server/public/img/graphExample.png
similarity index 100%
rename from public/img/graphExample.png
rename to server/public/img/graphExample.png
diff --git a/public/img/home-image.png b/server/public/img/home-image.png
similarity index 100%
rename from public/img/home-image.png
rename to server/public/img/home-image.png
diff --git a/public/img/linkedin-box.svg b/server/public/img/linkedin-box.svg
similarity index 100%
rename from public/img/linkedin-box.svg
rename to server/public/img/linkedin-box.svg
diff --git a/public/index.html b/server/public/index.html
similarity index 100%
rename from public/index.html
rename to server/public/index.html
diff --git a/public/js/createOrgInfo.js b/server/public/js/createOrgInfo.js
similarity index 100%
rename from public/js/createOrgInfo.js
rename to server/public/js/createOrgInfo.js
diff --git a/public/js/createOrgRepoGraph.js b/server/public/js/createOrgRepoGraph.js
similarity index 100%
rename from public/js/createOrgRepoGraph.js
rename to server/public/js/createOrgRepoGraph.js
diff --git a/public/js/createOrgTable.js b/server/public/js/createOrgTable.js
similarity index 100%
rename from public/js/createOrgTable.js
rename to server/public/js/createOrgTable.js
diff --git a/public/js/friendsGraph.js b/server/public/js/friendsGraph.js
similarity index 100%
rename from public/js/friendsGraph.js
rename to server/public/js/friendsGraph.js
diff --git a/public/js/githubAPI.js b/server/public/js/githubAPI.js
similarity index 100%
rename from public/js/githubAPI.js
rename to server/public/js/githubAPI.js
diff --git a/public/js/profileGen.js b/server/public/js/profileGen.js
similarity index 100%
rename from public/js/profileGen.js
rename to server/public/js/profileGen.js
diff --git a/public/js/profileTimeLine.js b/server/public/js/profileTimeLine.js
similarity index 100%
rename from public/js/profileTimeLine.js
rename to server/public/js/profileTimeLine.js
diff --git a/public/js/repoGen.js b/server/public/js/repoGen.js
similarity index 100%
rename from public/js/repoGen.js
rename to server/public/js/repoGen.js
diff --git a/public/js/utilities.js b/server/public/js/utilities.js
similarity index 100%
rename from public/js/utilities.js
rename to server/public/js/utilities.js
diff --git a/public/js/vis/img/network/acceptDeleteIcon.png b/server/public/js/vis/img/network/acceptDeleteIcon.png
similarity index 100%
rename from public/js/vis/img/network/acceptDeleteIcon.png
rename to server/public/js/vis/img/network/acceptDeleteIcon.png
diff --git a/public/js/vis/img/network/addNodeIcon.png b/server/public/js/vis/img/network/addNodeIcon.png
similarity index 100%
rename from public/js/vis/img/network/addNodeIcon.png
rename to server/public/js/vis/img/network/addNodeIcon.png
diff --git a/public/js/vis/img/network/backIcon.png b/server/public/js/vis/img/network/backIcon.png
similarity index 100%
rename from public/js/vis/img/network/backIcon.png
rename to server/public/js/vis/img/network/backIcon.png
diff --git a/public/js/vis/img/network/connectIcon.png b/server/public/js/vis/img/network/connectIcon.png
similarity index 100%
rename from public/js/vis/img/network/connectIcon.png
rename to server/public/js/vis/img/network/connectIcon.png
diff --git a/public/js/vis/img/network/cross.png b/server/public/js/vis/img/network/cross.png
similarity index 100%
rename from public/js/vis/img/network/cross.png
rename to server/public/js/vis/img/network/cross.png
diff --git a/public/js/vis/img/network/cross2.png b/server/public/js/vis/img/network/cross2.png
similarity index 100%
rename from public/js/vis/img/network/cross2.png
rename to server/public/js/vis/img/network/cross2.png
diff --git a/public/js/vis/img/network/deleteIcon.png b/server/public/js/vis/img/network/deleteIcon.png
similarity index 100%
rename from public/js/vis/img/network/deleteIcon.png
rename to server/public/js/vis/img/network/deleteIcon.png
diff --git a/public/js/vis/img/network/downArrow.png b/server/public/js/vis/img/network/downArrow.png
similarity index 100%
rename from public/js/vis/img/network/downArrow.png
rename to server/public/js/vis/img/network/downArrow.png
diff --git a/public/js/vis/img/network/editIcon.png b/server/public/js/vis/img/network/editIcon.png
similarity index 100%
rename from public/js/vis/img/network/editIcon.png
rename to server/public/js/vis/img/network/editIcon.png
diff --git a/public/js/vis/img/network/leftArrow.png b/server/public/js/vis/img/network/leftArrow.png
similarity index 100%
rename from public/js/vis/img/network/leftArrow.png
rename to server/public/js/vis/img/network/leftArrow.png
diff --git a/public/js/vis/img/network/minus.png b/server/public/js/vis/img/network/minus.png
similarity index 100%
rename from public/js/vis/img/network/minus.png
rename to server/public/js/vis/img/network/minus.png
diff --git a/public/js/vis/img/network/plus.png b/server/public/js/vis/img/network/plus.png
similarity index 100%
rename from public/js/vis/img/network/plus.png
rename to server/public/js/vis/img/network/plus.png
diff --git a/public/js/vis/img/network/rightArrow.png b/server/public/js/vis/img/network/rightArrow.png
similarity index 100%
rename from public/js/vis/img/network/rightArrow.png
rename to server/public/js/vis/img/network/rightArrow.png
diff --git a/public/js/vis/img/network/upArrow.png b/server/public/js/vis/img/network/upArrow.png
similarity index 100%
rename from public/js/vis/img/network/upArrow.png
rename to server/public/js/vis/img/network/upArrow.png
diff --git a/public/js/vis/img/network/zoomExtends.png b/server/public/js/vis/img/network/zoomExtends.png
similarity index 100%
rename from public/js/vis/img/network/zoomExtends.png
rename to server/public/js/vis/img/network/zoomExtends.png
diff --git a/public/js/vis/vis-graph3d.min.js b/server/public/js/vis/vis-graph3d.min.js
similarity index 100%
rename from public/js/vis/vis-graph3d.min.js
rename to server/public/js/vis/vis-graph3d.min.js
diff --git a/public/js/vis/vis-network.min.css b/server/public/js/vis/vis-network.min.css
similarity index 100%
rename from public/js/vis/vis-network.min.css
rename to server/public/js/vis/vis-network.min.css
diff --git a/public/js/vis/vis-network.min.js b/server/public/js/vis/vis-network.min.js
similarity index 100%
rename from public/js/vis/vis-network.min.js
rename to server/public/js/vis/vis-network.min.js
diff --git a/public/js/vis/vis-timeline-graph2d.min.css b/server/public/js/vis/vis-timeline-graph2d.min.css
similarity index 100%
rename from public/js/vis/vis-timeline-graph2d.min.css
rename to server/public/js/vis/vis-timeline-graph2d.min.css
diff --git a/public/js/vis/vis-timeline-graph2d.min.js b/server/public/js/vis/vis-timeline-graph2d.min.js
similarity index 100%
rename from public/js/vis/vis-timeline-graph2d.min.js
rename to server/public/js/vis/vis-timeline-graph2d.min.js
diff --git a/public/js/vis/vis.css b/server/public/js/vis/vis.css
similarity index 100%
rename from public/js/vis/vis.css
rename to server/public/js/vis/vis.css
diff --git a/public/js/vis/vis.js b/server/public/js/vis/vis.js
similarity index 100%
rename from public/js/vis/vis.js
rename to server/public/js/vis/vis.js
diff --git a/public/js/vis/vis.js.map b/server/public/js/vis/vis.js.map
similarity index 100%
rename from public/js/vis/vis.js.map
rename to server/public/js/vis/vis.js.map
diff --git a/public/js/vis/vis.map b/server/public/js/vis/vis.map
similarity index 100%
rename from public/js/vis/vis.map
rename to server/public/js/vis/vis.map
diff --git a/public/js/vis/vis.min.css b/server/public/js/vis/vis.min.css
similarity index 100%
rename from public/js/vis/vis.min.css
rename to server/public/js/vis/vis.min.css
diff --git a/public/js/vis/vis.min.js b/server/public/js/vis/vis.min.js
similarity index 100%
rename from public/js/vis/vis.min.js
rename to server/public/js/vis/vis.min.js
diff --git a/public/logo.svg b/server/public/logo.svg
similarity index 100%
rename from public/logo.svg
rename to server/public/logo.svg
diff --git a/public/style.css b/server/public/style.css
similarity index 100%
rename from public/style.css
rename to server/public/style.css
diff --git a/routes/api/v1.js b/server/routes/api/v1.js
similarity index 100%
rename from routes/api/v1.js
rename to server/routes/api/v1.js
diff --git a/routes/api/v2.js b/server/routes/api/v2.js
similarity index 100%
rename from routes/api/v2.js
rename to server/routes/api/v2.js
diff --git a/routes/index.js b/server/routes/index.js
similarity index 100%
rename from routes/index.js
rename to server/routes/index.js
diff --git a/run.sh b/server/run.sh
similarity index 100%
rename from run.sh
rename to server/run.sh
diff --git a/server.js b/server/server.js
similarity index 100%
rename from server.js
rename to server/server.js

From d3724f8b3c41accfe6f02d67cbee2196c29dd3f9 Mon Sep 17 00:00:00 2001
From: Kevin Assogba <43794220+10eMyrT@users.noreply.github.com>
Date: Sat, 8 Feb 2020 11:08:21 -0500
Subject: [PATCH 4/7] Update of README for more details (#36)

Updated README with more details
---
 README.md | 40 ++++++++++++++++++++++++++++++++--------
 1 file changed, 32 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index 7c7908c..7e527f6 100644
--- a/README.md
+++ b/README.md
@@ -4,9 +4,9 @@ Website for visualizing a persons github network.
 
 ![Example Graph](./doc/graphExample.png)
 
-If you are lucky, you can find the site live [here](https://github-graphs.com/);
+If you are lucky, you can find the site live [here](https://github-graphs.com/).
 
-# Built With
+## Built With
 
 - [BootStrap](https://getbootstrap.com/)
 - [jQuery](https://jquery.com/)
@@ -16,30 +16,54 @@ If you are lucky, you can find the site live [here](https://github-graphs.com/);
 
 ![javascript](./doc/javaScript.jpg)
 
-# Running
+## Native Deployment
 
-Create a .env file with the code below filled in.
+The easiest way to get started with Github-Graphs is to fork this repository
+and follow the instructions below.
+
+#### Create a new OAuth app
+
+The objective of creating an app under your github account is to access an
+endpoint through the GitHub API and obtain credentials to set your environment
+file. For directives on how to create a new OAuth app, consult the corresponding
+Github developer documentation [here](https://developer.github.com/apps/building-oauth-apps/creating-an-oauth-app/).
+
+#### Create a .env file
+
+Setup your environment credentials by creating a `.env file` inside the folder
+`/server` with the code below filled in.
 
 ```
-CLIENT_ID = <your_github_username>
-CLIENT_SECRET = <your_generated_personal_access>
+CLIENT_ID = <your_client_ID_from_oauth_app>
+CLIENT_SECRET = <your_generated_personal_access_from_oauth_app>
 SESSION_SECRET = <any_string_you_want>
 PORT = <any_number>
 ```
 
+#### Install dependencies
+
+Dependencies are installed using `npm`. Therefore, please install the package manager
+before proceeding. If you already have `npm` installed, run the command below inside
+`/server` in order to install the dependencies in the package directory.
+
 ```bash
 npm install
 ```
 
+#### Activate GitHub-Graphs
+
+Inside `/server`, run the following command to start the program, and in your
+browser, check `localhost:8000` to visualize your Github network.
+
 ```bash
 node server.js
 ```
 
-# Contributing
+## Contributing
 
 We are very open to new contributors. If you want to contribute to this project, and don't know where to start, look at the [open issues](https://github.com/jrtechs/github-graphs/issues). Once you know what you want to work on, comment on the issue and file a pull request.
 
-# API Reference
+## API Reference
 
 `GET https://github-graphs.com/api/friends/<username>`
 

From e0369a2ef216a336588b726d14a548d8bc9fba90 Mon Sep 17 00:00:00 2001
From: Kevin Assogba <43794220+10eMyrT@users.noreply.github.com>
Date: Sat, 8 Feb 2020 17:49:18 -0500
Subject: [PATCH 5/7] Authenticated requests working (#39)

Authenticated requests working with got
---
 server/routes/api/v1.js | 53 ++++++++++++++++++++++-------------------
 1 file changed, 29 insertions(+), 24 deletions(-)

diff --git a/server/routes/api/v1.js b/server/routes/api/v1.js
index 2ecc147..dc024f9 100644
--- a/server/routes/api/v1.js
+++ b/server/routes/api/v1.js
@@ -16,13 +16,18 @@ const API_PAGINATION = "&per_page=" + API_PAGINATION_SIZE;
 
 const REPOS_PATH = "/repos";
 
+const got_options  = {
+    json: true,
+    username : process.env.CLIENT_ID,
+    password : process.env.CLIENT_SECRET
+};
 
 /**
  * Queries data from the github APi server and returns it as
  * a json object in a promise.
- * 
+ *
  * This makes no attempt to cache
- * 
+ *
  * @param {*} requestURL endpoint on githubapi: ex: /users/jrtechs/following
  */
 function queryGithubAPIRaw(requestURL)
@@ -40,7 +45,7 @@ function queryGithubAPIRaw(requestURL)
         }
         console.log(queryURL);
 
-        got(queryURL, { json: true }).then(response =>
+        got(queryURL, got_options).then(response =>
         {
             resolve(response.body);
             cache.put(requestURL, response.body);
@@ -56,8 +61,8 @@ function queryGithubAPIRaw(requestURL)
 /**
  * Queries data from the github api server
  * and caches the results locally.
- * 
- * @param {*} requestURL 
+ *
+ * @param {*} requestURL
  */
 function queryGitHubAPI(requestURL)
 {
@@ -87,7 +92,7 @@ function queryGitHubAPI(requestURL)
 /**
  * Fetches all content from a particular github api endpoint
  * using their pagination schema.
- * 
+ *
  * @param {*} username username of github client
  * @param {*} apiPath following or followers
  * @param {*} page current pagination page
@@ -137,9 +142,9 @@ function fetchAllWithPagination(apiPath, page, lst)
 
 /**
  * Makes a copy of a JS object with certain properties
- * 
- * @param {*} props 
- * @param {*} obj 
+ *
+ * @param {*} props
+ * @param {*} obj
  */
 function copyWithProperties(props, obj)
 {
@@ -155,10 +160,10 @@ function copyWithProperties(props, obj)
 /**
  * Combines the list of friends and followers ignoring duplicates
  * that are already in the list. (person is both following and followed by someone)
- * 
+ *
  * This also removes any unused properties like events_url and organizations_url
- * 
- * @param {*} followingAndFollowers 
+ *
+ * @param {*} followingAndFollowers
  */
 function minimizeFriends(people)
 {
@@ -172,7 +177,7 @@ function minimizeFriends(people)
         {
             ids.add(people[i].id);
             friendLst.push({
-                login: people[i].login, 
+                login: people[i].login,
                 avatar_url: people[i].avatar_url
             });
         }
@@ -185,8 +190,8 @@ function minimizeFriends(people)
  * Fetches all the people that are either following or is followed
  * by a person on github. This will cache the results to make simultaneous
  * connections easier and less demanding on the github API.
- * 
- * @param {*} user 
+ *
+ * @param {*} user
  */
 function queryFriends(user)
 {
@@ -204,7 +209,7 @@ function queryFriends(user)
                     cache.put("/friends/" + user, fList);
                 }).catch((err)=>
                 {
-                    console.log(err);  
+                    console.log(err);
                     reject("API ERROR");
                 })
             }).catch((error)=>
@@ -223,13 +228,13 @@ function queryFriends(user)
 
 
 /**
- * 
+ *
  * Fetches all of the members of an organization from the
  * API or cache
  *
  * /orgs/RITlug/members?page=1
  *
- * @param {*} orgName 
+ * @param {*} orgName
  */
 function getOrganizationMembers(orgName)
 {
@@ -259,8 +264,8 @@ function getOrganizationMembers(orgName)
 
 /**
  * Minimizes the JSON for a list of repositories
- * 
- * @param {*} repositories 
+ *
+ * @param {*} repositories
  */
 function minimizeRepositories(repositories)
 {
@@ -268,7 +273,7 @@ function minimizeRepositories(repositories)
 
     for(var i = 0; i < repositories.length; i++)
     {
-        rList.push(copyWithProperties(["name", "created_at", "homepage", 
+        rList.push(copyWithProperties(["name", "created_at", "homepage",
             "description", "language", "forks", "watchers",
              "open_issues_count", "license", "html_url"],
             repositories[i]));
@@ -279,7 +284,7 @@ function minimizeRepositories(repositories)
 
 /**
  * Fetches all repositories from the API
- * 
+ *
  * @param {*} user name of org/user
  * @param {*} orgsOrUsers  either /users/ or /orgs/
  */
@@ -405,7 +410,7 @@ routes.get('/*', (request, result) =>
             }
 
         }
-        catch(error) 
+        catch(error)
         {
             result.write("[]");
         };
@@ -418,4 +423,4 @@ routes.get('/*', (request, result) =>
     }
 });
 
-module.exports = routes;
\ No newline at end of file
+module.exports = routes;

From 3dfe4404efba31b2fd1d354a7ad44bf9b1da1d20 Mon Sep 17 00:00:00 2001
From: Kevin Assogba <43794220+10eMyrT@users.noreply.github.com>
Date: Sun, 1 Mar 2020 21:24:48 -0500
Subject: [PATCH 6/7] Dockerfile added and readme updated (#40)

Added a docker-compose script for running and updated readme file. Closes (#14, #35)
---
 Dockerfile         | 27 +++++++++++++++
 README.md          | 82 +++++++++++++++++++++++++++++++++++++++-------
 docker-compose.yml | 11 +++++++
 3 files changed, 109 insertions(+), 11 deletions(-)
 create mode 100644 Dockerfile
 create mode 100644 docker-compose.yml

diff --git a/Dockerfile b/Dockerfile
new file mode 100644
index 0000000..8bc22ee
--- /dev/null
+++ b/Dockerfile
@@ -0,0 +1,27 @@
+FROM ubuntu
+LABEL maintainer="Jeffery Russell"
+
+# install all dependencies
+RUN apt-get update && \
+    apt-get upgrade -y && \
+    apt-get install -y build-essential && \
+    apt-get install -y sudo curl && \
+    curl -sL https://deb.nodesource.com/setup_13.x | sudo -E bash - && \
+    apt-get install -y nodejs && \
+    apt-get update && \
+    apt-get clean
+
+# Create a working directory for the container
+RUN mkdir /github-graphs
+
+# copy files from the directory of the Dockerfile to the docker container
+COPY /server /github-graphs/server
+COPY README.md /github-graphs/
+COPY LICENSE /github-graphs/
+
+# setup working directory to the default in the container
+WORKDIR /github-graphs/server
+
+# Install dependencies and start the program at RUN
+RUN npm install
+CMD ["node", "server.js"]
diff --git a/README.md b/README.md
index 7e527f6..0dcefcd 100644
--- a/README.md
+++ b/README.md
@@ -16,7 +16,8 @@ If you are lucky, you can find the site live [here](https://github-graphs.com/).
 
 ![javascript](./doc/javaScript.jpg)
 
-## Native Deployment
+
+## Deployment
 
 The easiest way to get started with Github-Graphs is to fork this repository
 and follow the instructions below.
@@ -25,13 +26,13 @@ and follow the instructions below.
 
 The objective of creating an app under your github account is to access an
 endpoint through the GitHub API and obtain credentials to set your environment
-file. For directives on how to create a new OAuth app, consult the corresponding
+file. For more information on how to create a new OAuth app, consult the corresponding
 Github developer documentation [here](https://developer.github.com/apps/building-oauth-apps/creating-an-oauth-app/).
 
 #### Create a .env file
 
-Setup your environment credentials by creating a `.env file` inside the folder
-`/server` with the code below filled in.
+After forking this repository, run the command `cd server/`. Inside that folder,
+setup your environment credentials by creating a `.env file` with the code below filled in.
 
 ```
 CLIENT_ID = <your_client_ID_from_oauth_app>
@@ -40,34 +41,91 @@ SESSION_SECRET = <any_string_you_want>
 PORT = <any_number>
 ```
 
+The creation of your OAuth app and the .env file are required steps,
+irrespective of your desired deployment environment. For specific directions,
+continue by following the steps specified below.
+
+### Deployment on the local machine
+
 #### Install dependencies
 
 Dependencies are installed using `npm`. Therefore, please install the package manager
 before proceeding. If you already have `npm` installed, run the command below inside
-`/server` in order to install the dependencies in the package directory.
+`server/` in order to install the dependencies in the package directory.
 
 ```bash
 npm install
 ```
 
-#### Activate GitHub-Graphs
+#### Explore GitHub-Graphs
 
-Inside `/server`, run the following command to start the program, and in your
+Inside `server/`, run the following command to start the program, and in your
 browser, check `localhost:8000` to visualize your Github network.
 
 ```bash
 node server.js
 ```
 
+### Deployment in a Docker container
+
+Github-graphs can also be deployed inside a docker container and displayed in
+your browser through port mapping. To get started run the following commands
+inside your forked repository.
+
+The easiest way to deploy in a docker container is through the use of our proposed
+`docker-compose.yml` file. If you choose this methodology, make sure the port numbers
+in your `.env` file matches the docker-compose file. Note that this approach will work
+only on systems which have Docker and Docker-compose both installed.
+Considering the example provided in our provided docker-compose,
+the port number of the .env file should be `PORT= 8000`. Therefore, you could
+visualize the Github-Graphs page at `localhost:8080` after running:
+
+```
+    docker-compose up -d --build
+```
+
+In order to clean the environment, you can run the following command.
+
+```
+    docker-compose down --rmi all
+
+```
+
+Besides the use of docker-compose, deployment with just docker is possible with the following commands:\
+
+```
+    docker build -t <choose_name_for_image> .
+    docker run -d --name <choose_name_for_container> -p <local_port_num>:<port_num_from_env_file> <name_of_image>
+```
+
+For instance, assume I name my image `graph-app`, my container `github-graphs`,
+and set the port number in my .env file to `8000`, I can decide to listen on my localhost at port `8080`.
+Therefore, my commands are:
+
+```
+    docker build -t graph-app .
+    docker run -d --name github-graphs -p 8080:8000 graph-app
+```
+
+If you are willing to read the debugging statement on the CLI, do not add `-d` to the `docker run` statement.
+
+At this step, you can now visualize Github graphs at `localhost:<local_port_num>`.
+
+
+
 ## Contributing
 
-We are very open to new contributors. If you want to contribute to this project, and don't know where to start, look at the [open issues](https://github.com/jrtechs/github-graphs/issues). Once you know what you want to work on, comment on the issue and file a pull request.
+We are very open to new contributors. If you want to contribute to this project,
+and don't know where to start, look at the [open issues](https://github.com/jrtechs/github-graphs/issues).
+Once you know what you want to work on, comment on the issue and file a pull request.
 
 ## API Reference
 
 `GET https://github-graphs.com/api/friends/<username>`
 
-Fetches `https://api.github.com/users/<username>/followers` [(GitHub Reference)](https://developer.github.com/v3/users/followers/#list-followers-of-a-user) and `https://api.github.com/users/<username>/following` [(GitHub Reference)](https://developer.github.com/v3/users/followers/#list-users-followed-by-another-user) to generate an array of users following `<username>` and that `<username>` follows each with values `login` and `avatar_url`.
+Fetches `https://api.github.com/users/<username>/followers` [(GitHub Reference)](https://developer.github.com/v3/users/followers/#list-followers-of-a-user)
+and `https://api.github.com/users/<username>/following` [(GitHub Reference)](https://developer.github.com/v3/users/followers/#list-users-followed-by-another-user)
+to generate an array of users following `<username>` and that `<username>` follows each with values `login` and `avatar_url`.
 
 Example result:
 
@@ -115,7 +173,8 @@ Example result:
 
 `GET https://github-graphs.com/api/org/users/<organization_name>`
 
-Fetches `https://api.github.com/orgs/<organization_name>/members` [(GitHub Reference)](https://developer.github.com/v3/orgs/members/#members-list) to generate an array of users that are in `<organization_name>` each with values `login` and `avatar_url`.
+Fetches `https://api.github.com/orgs/<organization_name>/members` [(GitHub Reference)](https://developer.github.com/v3/orgs/members/#members-list)
+to generate an array of users that are in `<organization_name>` each with values `login` and `avatar_url`.
 
 Example result:
 
@@ -132,7 +191,8 @@ Example result:
 
 `GET https://github-graphs.com/api/org/repositories/<organization_name>`
 
-Fetches `https://api.github.com/orgs/<organization_name>/repos` [(GitHub Reference)](https://developer.github.com/v3/repos/#list-organization-repositories) to return an array of repositories `<organization_name>` owns.
+Fetches `https://api.github.com/orgs/<organization_name>/repos` [(GitHub Reference)](https://developer.github.com/v3/repos/#list-organization-repositories)
+to return an array of repositories `<organization_name>` owns.
 
 Example result:
 
diff --git a/docker-compose.yml b/docker-compose.yml
new file mode 100644
index 0000000..d89633e
--- /dev/null
+++ b/docker-compose.yml
@@ -0,0 +1,11 @@
+
+version: '3.7'
+
+services:
+    github-graphs:
+        build:
+            dockerfile: Dockerfile
+        image: graph-app:latest
+        container_name: github-graphs
+        ports:
+            - "8080:8000"

From 0fe1c4428776f083b32fa1d7bd033ffa18daa618 Mon Sep 17 00:00:00 2001
From: Eric Lang <Eric@mail.rit.edu>
Date: Sun, 7 Nov 2021 15:20:20 -0500
Subject: [PATCH 7/7] Test driven development. (#41)

---
 server/package.json        | 22 ++++++++++++++--------
 server/routes/api/index.js |  2 ++
 server/routes/api/v2.js    |  2 +-
 server/routes/test/v2.js   | 11 +++++++++++
 server/run.sh              |  0
 server/server.js           | 12 ++++++++----
 6 files changed, 36 insertions(+), 13 deletions(-)
 create mode 100644 server/routes/api/index.js
 create mode 100644 server/routes/test/v2.js
 mode change 100644 => 100755 server/run.sh

diff --git a/server/package.json b/server/package.json
index f021d3b..5951414 100644
--- a/server/package.json
+++ b/server/package.json
@@ -1,28 +1,34 @@
 {
   "name": "github-graphs",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Generates graphs of github things.",
   "main": "server.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
+    "coveralls": "nyc npm test && nyc report --reporter=text-lcov | coveralls",
+    "test": "mocha routes/test --exit --reporter spec",
     "start": "node server.js"
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/jrtechs/github-graphs.git"
   },
-  "author": "Jeffery Russell",
+  "author": "Jeffery Russell, Eric Lang",
   "license": "ISC",
   "bugs": {
     "url": "https://github.com/jrtechs/github-graphs/issues"
   },
   "homepage": "https://github.com/jrtechs/github-graphs#readme",
   "dependencies": {
-    "dotenv": "^8.2.0",
-    "express": "^4.16.4",
-    "express-session": "^1.15.6",
+    "dotenv": "~8.2.0",
+    "express": "~4.16.4",
+    "express-session": "~1.15.6",
     "fs": "0.0.1-security",
-    "got": "^9.6.0",
-    "memory-cache": "^0.2.0"
+    "got": "~9.6.0",
+    "memory-cache": "~0.2.0"
+  },
+  "devDependencies": {
+    "coveralls": "*",
+    "mocha": "*",
+    "nyc": "*"
   }
 }
diff --git a/server/routes/api/index.js b/server/routes/api/index.js
new file mode 100644
index 0000000..864dc35
--- /dev/null
+++ b/server/routes/api/index.js
@@ -0,0 +1,2 @@
+exports.V1 = require('./v1');
+exports.V2 = require('./v2');
\ No newline at end of file
diff --git a/server/routes/api/v2.js b/server/routes/api/v2.js
index 4e17a72..b71a463 100644
--- a/server/routes/api/v2.js
+++ b/server/routes/api/v2.js
@@ -307,4 +307,4 @@ routes.get('/*', (request, result) =>
     }
 });
 
-module.exports = routes;
\ No newline at end of file
+module.exports = routes;
diff --git a/server/routes/test/v2.js b/server/routes/test/v2.js
new file mode 100644
index 0000000..1a940c9
--- /dev/null
+++ b/server/routes/test/v2.js
@@ -0,0 +1,11 @@
+const assert = require('assert');
+const V2 = require('../api/v2');
+
+describe('github api v2', function() {
+    it('successfully queries friends', async function() {
+        var queryFriends = V2.queryFriends;
+        // it was this point that Eric realized he doesn't understand
+        // module.exports very well.
+        assert.strictEqual(typeof(queryFriends), typeof(queryFriends));
+    });
+});
\ No newline at end of file
diff --git a/server/run.sh b/server/run.sh
old mode 100644
new mode 100755
diff --git a/server/server.js b/server/server.js
index b99e1e7..f80ec48 100644
--- a/server/server.js
+++ b/server/server.js
@@ -1,10 +1,14 @@
+const crypto = require('crypto');
+
+const app = express();
+
+const dotenv = require("dotenv").config();
 const express = require("express");
 const session = require('express-session');
-const dotenv = require("dotenv").config();
-const app = express();
+
 
 const sessionProperties = {
-    secret: process.env.SESSION_SECRET, 
+    secret: process.env.SESSION_SECRET || crypto.randomBytes(64), 
     cookie: { maxAge: 6000000 },
     resave: false,
     saveUninitialized: false
@@ -18,4 +22,4 @@ const routes = require('./routes');
 app.use('/', routes);
 
 
-app.listen(process.env.PORT, () => console.log(`App listening on port ${process.env.PORT}!`));
\ No newline at end of file
+app.listen(process.env.PORT || 8100, () => console.log(`App listening on port ${process.env.PORT  || 8100}!`));
\ No newline at end of file