Merge pull request #53 from JetJet13/develop

Merge Develop to Master | v1.1.0

Author: JetJet13

.eslintrc

@@ -55,7 +55,6 @@
   },
   "env": {
     "node": true,
-    "mocha": true,
     "es6": true,
     "jquery": true
   },

.gitignore

@@ -1,8 +1,11 @@
 # vscode
 .vscode/
 node_modules
+coverage
+.nyc_output
 npm-debug.log
-src/logs/
-src/public/tags/
-src/public/javascripts/all.js
+src/server/logs/
+src/front-end/public/javascripts/riot-tags.bundle.js
+src/front-end/public/dist/*.css
+src/front-end/public/dist/*.js
 config/local.json

.nvmrc

@@ -0,0 +1 @@
+8

.snyk

@@ -0,0 +1,14 @@
+# Snyk (https://snyk.io) policy file, patches or ignores known vulnerabilities.
+version: v1.10.1
+ignore: {}
+# patches apply the minimum changes required to fix a vulnerability
+patch:
+  'npm:debug:20170905':
+    - riot > riot-cli > chokidar > fsevents > node-pre-gyp > tar-pack > debug:
+        patched: '2017-12-16T18:51:09.363Z'
+  'npm:tough-cookie:20170905':
+    - riot > riot-cli > chokidar > fsevents > node-pre-gyp > request > tough-cookie:
+        patched: '2017-12-16T18:51:09.363Z'
+  'npm:request:20160119':
+    - github-oauth > request:
+        patched: '2018-01-07T16:34:19.511Z'

.travis.yml

@@ -0,0 +1,19 @@
+language: node_js
+notifications:
+  webhooks:
+    urls:
+      - https://webhooks.gitter.im/e/f277e1d11bf3828eec05
+    on_success: change
+    on_failure: always
+    on_start: never
+env:
+  - NODE_ENV=test
+before_install:
+  - npm install -g npm@5
+  - npm install -g greenkeeper-lockfile@1
+before_script:
+  - greenkeeper-lockfile-update
+  - npm install -g gulp-cli
+  - npm install
+script: gulp test
+after_script: greenkeeper-lockfile-upload

README.md

@@ -1,5 +1,9 @@
 # Mathbook
 
+[![Build Status](https://travis-ci.org/JetJet13/mathbook.svg?branch=develop)](https://travis-ci.org/JetJet13/mathbook)
+[![Greenkeeper badge](https://badges.greenkeeper.io/JetJet13/mathbook.svg)](https://greenkeeper.io/)
+[![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/mathbook-chat/Lobby)
+
 Mathbook is a website that provides peer-reviewed tutorials on topics covering most subjects in mathematics.
 
 Mathbook is written in JavaScript and built using NodeJS, ExpressJS, Riot and Pug (formerly known as Jade)
@@ -27,6 +31,8 @@ wget http://download.redis.io/redis-stable.tar.gz
 tar xvzf redis-stable.tar.gz
 cd redis-stable
 make
+make test
+make install
 
 # mac osx users
 brew install redis
@@ -51,6 +57,45 @@ gulp serve
 gulp serve | bunyan
 ```
 
+If you want to get the GitHub OAuth Login functionality working, you will need to do the following,
+
+1. Visit github.com and Sign In
+2. Navigate to your profile settings page
+3. In the side bar, find and click on `Developer Settings`
+4. Then click on `New OAuth App`
+5. You will then be navigated to a page that looks similar to this,
+
+![screenshot](./setting-up-mathbook-app.png)
+
+6. Confirm that the `Homepage URL` and `Authorization callback URL` you entered match what you see in the screenshot
+   above.
+7. Click `Update Application`
+8. Now, copy the `clientId` and `clientSecret` for your newly created Application into your `config/local.json` file.
+
+Your `local.json` file should look something like the following,
+
+```json
+{
+  "bin": {
+    "protocol": "http",
+    "host": "127.0.0.1",
+    "port": 4000,
+    "domain": "localhost",
+    "proxyPort": 4001
+  },
+
+  "github": {
+    "clientId": "<CLIENT_ID>",
+    "clientSecret": "<CLIENT_SECRET>"
+  },
+  "redis": {
+    "host": "127.0.0.1",
+    "port": 6379,
+    "password": "<REDIS_PASSWORD>"
+  }
+}
+```
+
 ## Testing
 
 ```bash

bin/createLogFile

@@ -0,0 +1,10 @@
+#!/usr/bin/env node
+
+const fs = require("fs")
+
+const logFilePath = "./src/server/logs/error-logs.json"
+
+if (fs.existsSync(logFilePath) === false) {
+  fs.writeFileSync(logFilePath, "", "utf-8")
+}
+process.exit()

config/config.js

@@ -12,7 +12,7 @@ const getConfiguration = () => {
   config = convict({
     env: {
       doc: "The application environment.",
-      format: ["production", "development", "local"],
+      format: ["production", "development", "local", "test"],
       default: "local",
       env: "NODE_ENV"
     },
@@ -55,11 +55,17 @@ const getConfiguration = () => {
     },
     bin: {
       protocol: {
-        doc: "The protocol to open a connection",
+        doc: "The Hypertext Transfer Protocol",
         format: ["http", "https"],
         default: "https",
         env: "PROTOCOL"
       },
+      domain: {
+        doc: "The domain name",
+        format: "String",
+        default: "mathbook.io",
+        env: "DOMAIN_NAME"
+      },
       host: {
         doc: "The IP address to bind.",
         format: "ipaddress",
@@ -71,6 +77,12 @@ const getConfiguration = () => {
         format: "port",
         default: 4000,
         env: "PORT"
+      },
+      proxyPort: {
+        doc: "The port that browser-sync will use to proxy the server",
+        format: "port",
+        default: 4001,
+        env: "PROXY_PORT"
       }
     }
   })

config/development.json

@@ -2,7 +2,8 @@
   "bin": {
     "protocol": "http",
     "host": "127.0.0.1",
-    "port": 4000
+    "port": 4000,
+    "domain": "127.0.0.1"
   },
   "redis": {
     "host": "127.0.0.1",

config/production.json

@@ -2,7 +2,8 @@
   "bin": {
     "protocol": "http",
     "host": "127.0.0.1",
-    "port": 4000
+    "port": 4000,
+    "domain": "mathbook.io"
   },
   "redis": {
     "host": "127.0.0.1",

config/test.json

@@ -0,0 +1,8 @@
+{
+  "bin": {
+    "protocol": "http",
+    "host": "127.0.0.1",
+    "port": 4000,
+    "domain": "127.0.0.1"
+  }
+}

gulpfile.js

@@ -3,12 +3,15 @@
 const gulp = require("gulp")
 const plugins = require("gulp-load-plugins")()
 const browserSync = require("browser-sync").create()
+const config = require("./config/config")()
 
 const files = {
   allFiles: ["src/server/**/*.js", "tests/*.spec.js", "!src/front-end/public/javascripts/*.js"],
   testFiles: ["./tests/**/*.spec.js"],
-  srcFiles: ["./src/server/**/*.js", "./src/server/**/*.pug", "./src/server/**/*.css"],
+  watchFiles: ["./src/server/**/*.js", "./src/front-end/**/*.css", "./src/front-end/views/*.pug"],
   srcTestFiles: ["./src/server/**/*.js"],
+  jsFiles: ["!src/front-end/public/javascripts/riot-tags.bundle.js", "src/front-end/public/javascripts/*.js"],
+  cssFiles: ["./src/front-end/public/stylesheets/*.css"],
   tagFiles: ["./src/front-end/tags/**/*.tag"]
 }
 
@@ -24,21 +27,34 @@ gulp.task("lint", () => {
   )
 })
 
-gulp.task("test:config", () => {
-  return (
-    gulp
-      .src(files.srcTestFiles)
-      // Covering files
-      .pipe(plugins.istanbul())
-      // Force `require` to return covered files
-      .pipe(plugins.istanbul.hookRequire())
-  )
+gulp.task("bundle:js", ["riot"], () => {
+  const jsFiles = ["src/front-end/public/javascripts/*.js", "!src/front-end/public/javascripts/riotInit.js"]
+  const jsDest = "src/front-end/public/dist/"
+
+  return gulp
+    .src(jsFiles)
+    .pipe(plugins.babel({ presets: ["env"] }))
+    .pipe(plugins.concat("bundle.min.js"))
+    .pipe(gulp.dest(jsDest))
+    .pipe(plugins.uglify())
+    .pipe(gulp.dest(jsDest))
 })
 
-gulp.task("test", ["test:config"], () => {
+gulp.task("bundle:css", () => {
+  const cssDest = "src/front-end/public/dist/"
+
+  return gulp
+    .src(files.cssFiles)
+    .pipe(plugins.concat("bundle.min.css"))
+    .pipe(gulp.dest(cssDest))
+    .pipe(plugins.uglifycss())
+    .pipe(gulp.dest(cssDest))
+})
+
+gulp.task("test", () => {
   gulp
     .src(files.testFiles)
-    .pipe(plugins.mocha())
+    .pipe(plugins.ava())
     .once("error", () => {
       process.exit(1)
     })
@@ -47,66 +63,53 @@ gulp.task("test", ["test:config"], () => {
     })
 })
 
-// we'd need a slight delay to reload browsers
-// connected to browser-sync after restarting nodemon
-const BROWSER_SYNC_RELOAD_DELAY = 500
-
-gulp.task("nodemon", function(cb) {
+gulp.task("nodemon", function(done) {
   let called = false
   return plugins
     .nodemon({
       // nodemon our expressjs server
-      script: "./bin/www"
+      script: "./bin/www",
+      ignore: ["src/front-end/public", "src/front-end/tags"]
     })
     .on("start", function onStart() {
       // ensure start only got called once
       if (!called) {
-        cb()
+        const host = config.get("bin.host")
+        const port = config.get("bin.port")
+        const proxyPort = config.get("bin.proxyPort")
+        setTimeout(() => {
+          browserSync.init({
+            proxy: `${host}:${port}`,
+            port: proxyPort
+          })
+        }, 2000)
+        done()
       }
       called = true
-    })
-    .on("restart", function onRestart() {
-      // reload connected browsers after a slight delay
-      setTimeout(function reload() {
-        browserSync.reload({
-          stream: false
-        })
-      }, BROWSER_SYNC_RELOAD_DELAY)
+      // for more browser-sync config options: http://www.browsersync.io/docs/options/
     })
 })
 
 gulp.task("riot", function() {
-  gulp
+  return gulp
     .src(files.tagFiles)
     .pipe(plugins.riot())
-    .pipe(plugins.concat("all.js"))
+    .pipe(plugins.concat("riot-tags.bundle.js"))
     .pipe(gulp.dest("./src/front-end/public/javascripts"))
-  // .pipe(gulp.dest('./src/public/tags'))
 })
 
 gulp.task("serve", ["nodemon"], function() {
-  // for more browser-sync config options: http://www.browsersync.io/docs/options/
-  browserSync.init({
-    // informs browser-sync to proxy our expressjs app which would run at the following location
-    proxy: "http://192.168.2.22:3000",
-
-    // informs browser-sync to use the following port for the proxied app
-    // notice that the default port is 3000, which would clash with our expressjs
-    port: 4000
-  })
-
-  gulp.watch(files.tagFiles, ["riot"])
-  gulp.watch(files.srcFiles).on("change", browserSync.reload)
+  gulp.watch(files.tagFiles, ["reload:js"])
+  gulp.watch(files.jsFiles, ["reload:js"])
+  gulp.watch(files.cssFiles, ["reload:css"])
+  gulp.watch(files.watchFiles).on("change", browserSync.reload)
 })
 
-gulp.task("default", () =>
-  gulp
-    .src(files.testFiles)
-    .pipe(plugins.mocha())
-    .once("error", () => {
-      process.exit(1)
-    })
-    .once("end", () => {
-      process.exit()
-    })
-)
+gulp.task("reload:js", ["bundle:js"], done => {
+  browserSync.reload()
+  done()
+})
+gulp.task("reload:css", ["bundle:css"], done => {
+  browserSync.reload()
+  done()
+})