Created an initial boilerplate for the project (#1)

 initial boilerplate for the project_1

Author: ankurnarkhede

.gitignore

@@ -0,0 +1,123 @@
+# Created by .ignore support plugin (hsz.mobi)
+### Node template
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.pnp.*
+
+# Jetbrains IDE files
+.idea
+
+# VSCode files
+.vscode

README.md

@@ -1,2 +1,11 @@
-# website-template
-A template to create all public facing sites
+# Website Backend
+
+## Steps
+- Clone the repository
+- Navigate into the repo
+
+## Running the project
+```shell script
+$ npm install
+$ npm start 
+```

app.js

@@ -0,0 +1,40 @@
+const createError = require('http-errors')
+const express = require('express')
+const cookieParser = require('cookie-parser')
+const morgan = require('morgan')
+const boom = require('express-boom')
+const helmet = require('helmet')
+const cors = require('cors')
+
+// import routes
+const indexRouter = require('./routes/index')
+
+const app = express()
+
+app.use(morgan('combined'))
+app.use(express.json())
+app.use(express.urlencoded({ extended: false }))
+app.use(cookieParser())
+app.use(helmet())
+app.use(cors())
+app.use(boom())
+
+app.use('/', indexRouter)
+
+// catch 404 and forward to error handler
+app.use(function (req, res, next) {
+  next(createError(404))
+})
+
+// error handler
+app.use(function (err, req, res, next) {
+  // set locals, only providing error in development
+  res.locals.message = err.message
+  res.locals.error = req.app.get('env') === 'development' ? err : {}
+
+  // render the error page
+  res.status(err.status || 500)
+  res.boom.badRequest('Invalid request')
+})
+
+module.exports = app

config/default.js

@@ -0,0 +1,3 @@
+module.exports = {
+  port: process.env.PORT || 3000
+}

config/development.js

@@ -0,0 +1,3 @@
+module.exports = {
+  port: process.env.PORT || 3000
+}

config/production.js

@@ -0,0 +1,3 @@
+module.exports = {
+  port: process.env.PORT || 3000
+}

config/staging.js

@@ -0,0 +1,3 @@
+module.exports = {
+  port: process.env.PORT || 3000
+}

config/test.js

@@ -0,0 +1,3 @@
+module.exports = {
+  port: process.env.PORT || 3000
+}

controllers/healthController.js

@@ -0,0 +1,15 @@
+/**
+ * Route used to get the health status of teh server
+ *
+ * @param req {Object} - Express request object
+ * @param res {Object} - Express request object
+ */
+const healthCheck = (req, res) => {
+  return res.json({
+    uptime: process.uptime()
+  })
+}
+
+module.exports = {
+  healthCheck
+}