Template Application

Starter Code for a Javascript application

Prerequisites

• Node JS (Version 10.16.0) - Download and install Node JS from Node Js Download Page if not already installed on system.

Steps to run Locally

# Clone the repository
git clone https://github.com/manpreet-compro/lti-seed-app.git

# Change directory
cd lti-seed-app

# Install NPM dependencies
npm install

# Then simply start your app
npm start

# Test on localhost
http://localhost:3000

Project Structure

├───config 			# Configuration files 
├───public			# Client-side application, e.g. image assets, stylesheets and javascript files
│   ├───css
│   └───js
├───routes			# Server-side end points. For each route, there will be a corresponding controller file in "Controllers" folder
├───controllers		        # Server-side controllers responsible for request handling and generating corresponding response as per business logic
├───validators		        # Server-side request validations
└───views			# Server-side view templates. 
    ├───layouts
    └───partials
├───helpers			# Common utility functions 
├───test			# Files containing unit test cases

Node Packages used

• dependencies
  • express - Servside framework
  • express-session - For server side session
  • memorystore - For saving session without datastore
  • config - To manage environment based config files
  • ajv - For Request validations
  • body-parser - For parsing incoming post request data
  • hbs - Handlebars Templating engine for server side views
  • express-handlebars - Integarting handlebars with express
  • helmet - For securing app by setting http headers
  • winston - For logging
• devDependencies - For development only
  • mocha - Testing Framework for unit tests
  • chai - Testing Assertion library for writing unit tests
  • supertest - Testing lib for node js http requests
  • nodemon - For local development environment

Environment Setup / Variables

• NODE_ENV - Application environment. Possible values are development and production.

Copyright and license

-- TODO --