Dev Setup

Required tools

1. nodejs

   If you have already installed node version 12.13.1, ignore it

   download node and install

2. code editor

   visual studio code (current version)

   to install visual studio code click here

Setup for development

To contribute for this project you need to do the following things.

1. clone the repository

git clone https://github.com/step-batch-7/runtimeTerror-risk.git

2. install dependencies

npm install

3. Dependancies

   eslint - developer dependancy for standardising code. Rules are preset in .eslintrc.json and lint check can be done by running npx eslint <filePath>

   mocha - developer dependancy for unit tests as a testing framework

   supertest - developer dependancy for server test

   nodemon - developer dependancy for running the server code.

   express - server side dependancy

   cookie-parser - parses cookies

   moment - time formatting

   redis - dependancy for persisting data

Project skeleton

public directory for files those are directly available to the user

test directory for test related code

src directory for source files those are responsible for back-end.

scripts directory for dev setup, there are git hook; make sure you run this script when you have cloned the repository.

to run hook scripts go to your project directory then run these commands

chmod +x scripts/gitHooks.sh

./scripts/gitHooks.sh