Release v1.1.0

Author: rak3rman

.gitignore

@@ -5,4 +5,4 @@
 
 node_modules/
 
-config/sysConfig\.json
+config/config\.json

README.md

@@ -1,25 +1,25 @@
 # Base WebFramework NodeJS
 [![Build Status](https://travis-ci.org/RAK3RMAN/base-webframework-nodejs.svg?branch=master)](https://travis-ci.org/RAK3RMAN/base-webframework-nodejs)
 
-A general template for a nodejs web application running express
+A general template for a Node.js web application running Fastify and Handlebars
 
 ### Basic Structure
-This project is a base web framework to run a web application using express through NodeJS. Being a 'base' framework, this project only displays a webpage through a specified port with no authentication. The structure of this application is described below in the application map.
+This project is a base web framework to run a web application using Fastify through Node.js. Being a 'base' framework, this project only displays a webpage through a specified port with no authentication. The structure of this application is described below in the application map.
 
 ### Application Map
 ```
 --app.js # Primary NodeJS file
 --routes # Routes for views
-  --mainRoutes.js
---views # Components of webpage, HTML
-  --pages
-    --home.ejs # Home Page
-    --error.ejs # Error Page
+  --error-routes.js
+--templates # Components of webpage, HTML
+  --home.ejs # Home Page
+  --error.ejs # Error Page
 --config # Folder where configurations are set
-  --exitOpt.js # Exit options when running in testing environment
-  --sysConfig.json # Appears upon system configuration within application
---static # Place static files to be accessed by webpage here
---package.json # NPM 
+  --testing.js # Exit options when running in testing environment
+  --setup.json # Helper file for config.json
+  --config.json # Appears upon system configuration within application
+--public # Place static files to be accessed by webpage here
+--package.json
 --package-lock.json
 --start.sh
 --LICENSE
@@ -29,7 +29,7 @@ This project is a base web framework to run a web application using express thro
 ```
 
 ## Install and Setup
-- Clone the repository from github.com
+- Clone the repository from https://github.com
 ```
 git clone https://github.com/RAK3RMAN/base-webframework-nodejs.git
 ```
@@ -42,8 +42,8 @@ git clone https://github.com/RAK3RMAN/base-webframework-nodejs.git
         - `npm start`
     - If you want a different broadcast port, you can configure these values by proceeding with the:
         - Hardcode option:
-            - Enter the `sysConfig.json` file
-                - `sudo nano base-webframework-nodejs/config/sysConfig.json`
-            - Edit the `console_port` parameter to your desired configuration
+            - Enter the `config.json` file
+                - `sudo nano base-webframework-nodejs/config/config.json`
+            - Edit the `webserver_port` parameter to your desired configuration
     - If any errors occur, please read the logs and attempt to resolve. If resolution cannot be achieved, post in the issues under this project. 
 - Access web application through `localhost:3000`

app.js

@@ -1,122 +1,86 @@
-/*\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\
-App/Filename : BASE/app.js
-Description  : Initializes nodejs
-Author       : RAk3rman
-\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\*/
-
-//===================================================//
-//     --- Initialize Packages and Routers ---       //
-//===================================================//
-
-//Declare Packages
-let express = require('express');
-let session = require('express-session');
-let morgan = require('morgan');
-let createError = require('http-errors');
-let cookieParser = require('cookie-parser');
-let bodyParser = require('body-parser');
-let ip = require('ip');
-let uuidv4 = require('uuid/v4');
-
-//Setup Local Database
-let dataStore = require('data-store');
-let storage = new dataStore({path: './config/sysConfig.json'});
-
-//System Config Checks - - - - - - - - - - - - - - - - -
-//Session Secret Check
-let session_secret = storage.get('session_secret');
-if (session_secret === undefined) {
-    let newSecret = uuidv4();
-    storage.set('session_secret', newSecret);
-    console.log('Config Manager: Session Secret Set - ' + newSecret);
-}
-//Console Port Check
-let console_port = storage.get('console_port');
-if (console_port === undefined) {
-    storage.set('console_port', 3000);
-    console.log('Config Manager: Port Set to DEFAULT: 3000');
-}
-//End of System Config Checks - - - - - - - - - - - - - -
-
-//Declare App
-const app = express();
-app.set('view engine', 'ejs');
-
-//Initialize Exit Options (for Testing Environments)
-let exitOpt = require('./config/exitOpt.js');
-setTimeout(exitOpt.testCheck, 3000);
-
-//Routers
-let mainRoutes = require('./routes/mainRoutes.js');
-
-//Express Processes/Packages Setup
-app.use(session({
-    secret: storage.get('session_secret'),
-    resave: true,
-    saveUninitialized: true
-}));
-app.use(cookieParser());
-app.use(bodyParser.urlencoded({extended: true}));
-app.use(bodyParser.json());
-app.use(morgan('dev'));
-app.use(express.json());
-app.use(express.urlencoded({extended: false}));
-
-//Import Static Files to Webpages
-app.use('/static', express.static(process.cwd() + '/static'));
-
-//End of Initialize Packages and Routers - - - - - - - -
-
-
-//===================================================//
-//       --- LEMAgent Config Routes/Logic  ---       //
-//===================================================//
-
-//Create Routes
-app.get('/', mainRoutes.homeRoute);
-
-//End of LEMAgent Config Routes/Logic - - - - - - - - -
-
-
-//===================================================//
-//              --- Error Handlers ---               //
-//===================================================//
-
-//404 - Send to Error Handler
-app.use(function (req, res, next) {
-    next(createError(404));
-});
-
-// Error Handler Logic
-app.use(function (err, req, res, next) {
-    //Determine Message
-    res.locals.message = err.message;
-    res.locals.error = req.app.get('env') === 'development' ? err : {};
-    //Render Error Page
-    res.status(err.status || 500);
-    res.render('pages/error.ejs', {title: 'Error'});
-});
-
-//End of Error Handler - - - - - - - - - - - - - - - - -
-
-
-//===================================================//
-//        --- External Connections Setup ---         //
-//===================================================//
-
-//Port Listen
-let http = require('http');
-let server = http.createServer(app);
-server.listen(storage.get('console_port'), function () {
-    console.log(' ');
-    console.log('============================================');
-    console.log('  Base-WebFramework-NodeJS | RAk3rman 2019  ');
-    console.log('============================================');
-    console.log('Web Page Accessable at: ' + ip.address() + ":" + storage.get('console_port'));
-    console.log(' ');
-});
-
-//End of External Connections Setup - - - - - - - - - -
-
-//Export Express
-module.exports = app;
+/*\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\
+Filename : base/app.js
+Desc     : main application file
+Author(s): RAk3rman
+\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\*/
+
+// Packages and configuration - - - - - - - - - - - - - - - - - - - - - - - - -
+
+// Declare packages
+const path = require('path');
+const dataStore = require('data-store');
+const config_storage = new dataStore({path: './config/config.json'});
+const chalk = require('chalk');
+const pkg = require('./package.json');
+const moment = require('moment');
+const wipe = chalk.white;
+
+// Print header to console
+console.clear();
+console.log(chalk.blue.bold('\nBase Webframework v' + pkg.version + ((process.argv[2] !== undefined) ? ' | ' + process.argv[2].toUpperCase() : "" )));
+console.log(chalk.white('--> Contributors: ' + pkg.author));
+console.log(chalk.white('--> Description: ' + pkg.description));
+console.log(chalk.white('--> Github: ' + pkg.homepage + '\n'));
+
+// Check configuration values
+let setup = require('./config/setup.js');
+setup.check_values(config_storage);
+
+// End of Packages and configuration - - - - - - - - - - - - - - - - - - - - - -
+
+// Fastify and main functions - - - - - - - - - - - - - - - - - - - - - - - - - -
+
+// Declare fastify
+const fastify = require('fastify')({logger: false});
+
+// Prepare rendering template
+fastify.register(require('point-of-view'), {
+    engine: {
+        handlebars: require('handlebars')
+    },
+})
+fastify.register(require('fastify-static'), {
+    root: path.join(__dirname, 'public'),
+    prefix: '/public/',
+})
+// fastify.register(require('fastify-socket.io'), {})
+// fastify.register(require('fastify-formbody'))
+// fastify.register(require('fastify-rate-limit'), {
+//     global: false,
+//     max: 250,
+//     timeWindow: '1 minute'
+// })
+
+// Routers
+let error_routes = require('./routes/error-routes.js');
+
+// Import routes
+error_routes(fastify);
+
+// Home page
+fastify.get('/', (req, reply) => {
+    reply.view('/templates/home.hbs', {
+        title: "Home"
+    })
+    console.log(wipe(`${chalk.bold.magenta('Fastify')}: [` + moment().format('MM/DD/YY-HH:mm:ss') + `] GET /`));
+})
+
+// End of Fastify and main functions - - - - - - - - - - - - - - - - - - - - - -
+
+
+// Setup external connections - - - - - - - - - - - - - - - - - - - - - - - - -
+
+// Start webserver using config values
+console.log(wipe(`${chalk.bold.magenta('Fastify')}: [` + moment().format('MM/DD/YY-HH:mm:ss') + `] Attempting to start http webserver on port ` + config_storage.get('webserver_port')));
+fastify.listen(config_storage.get('webserver_port'), function (err) {
+    if (err) {
+        fastify.log.error(err)
+        process.exit(1)
+    }
+    console.log(wipe(`${chalk.bold.magenta('Fastify')}: [` + moment().format('MM/DD/YY-HH:mm:ss') + `] Running http webserver on port ` + config_storage.get('webserver_port')));
+    // Check if we are testing
+    const testing = require('./config/testing.js');
+    testing.testCheck();
+})
+
+// End of Setup external connections - - - - - - - - - - - - - - - - - - - - - -

config/setup.js

@@ -0,0 +1,31 @@
+/*\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\
+Filename : base/config/setup.js
+Desc     : checks and sets up configuration values
+           in config.json using data-store
+Author(s): RAk3rman
+\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\*/
+
+// Packages
+const chalk = require('chalk');
+const wipe = chalk.white;
+const moment = require('moment');
+
+// Name : setup.check_values()
+// Desc : checks all config.json values and configures each value if invalid
+// Author(s) : RAk3rman
+exports.check_values = function (config_storage) {
+    console.log(wipe(`${chalk.bold.cyan('Setup')}:   [` + moment().format('MM/DD/YY-HH:mm:ss') + `] Checking configuration values`));
+    let invalid_config = false;
+    // Config value: webserver_port | the port where the webserver will listen for requests
+    if (!config_storage.has('webserver_port') || config_storage.get('webserver_port') === '') {
+        config_storage.set('webserver_port', 3000);
+        console.log(wipe(`${chalk.bold.cyan('Setup')}:   [` + moment().format('MM/DD/YY-HH:mm:ss') + `] "webserver_port" value in config.json set to default: "3000"`));
+    }
+    // Exit if the config values are not set properly
+    if (invalid_config) {
+        console.log(wipe(`${chalk.bold.cyan('Setup')}:   [` + moment().format('MM/DD/YY-HH:mm:ss') + `] Please check "config.json" and configure the appropriate values`));
+        process.exit(0);
+    } else {
+        console.log(wipe(`${chalk.bold.cyan('Setup')}:   [` + moment().format('MM/DD/YY-HH:mm:ss') + `] Configuration values have been propagated`));
+    }
+}