Videly

A NodeJs Example

This project is fully controll the backend of Movies Rental Shop. This projects is build on by using lot of dependencies like Express, MongoDB and Fawn etc. Here you can get help in creating and designing MongoDB database using NodeJs. There is a full guide, how you can get start in NodeJS.

MongoDB on Mac: To install mongodb on Mac follow this link: Install on Mac.

MongoDB on Windows: To install MongoDB on Windows follow this link: Install on Windows.

How to set Environment variable and run?

On Mac:

// for testing case
export ENV_NODE=test node index.js 

on windows:

// for testing case
set ENV_NODE=test
node index.js

What is Fawn?

Fawn is library to store data in different tables with one request. For example: I'm going to insert a value A in table Movies and same time I wanna update a table Customers with Value B. If 1st table value is inserted and that time 2nd table were not updated with any means, then the value inserted in table one will be reverted. Fawn is actually a promise to store data. For more detail follow this link: Fawn.

Lodash

A JavaScript library to get request body objects in nicer way and pass to the object to store, for more Click here.

Joi Password Complexity

Creates a Joi object that validates password complexity. Joi Password Complexity.

BCrypt

This library is just to handle passwords from simple shape to encrypted one. Lib to help you hash passwords. node.bcrypt.js.

$npm i bcrypt

const bcrypt = require('bcrypt');
const validPassword = await bcrypt.compare(req.body.password, user.password);
if (!validPassword) 
    return res.status(400).send('Invalid email or password.');

JSON Web Token (jwt)

A library to handle token which is being generated while signin process etc. Click here for details.

npm i jsonwebtoken
const token = jwt.sign({ _id: user._id, name: user.name }, config.get('jwtPrivateKey'));

Config

• $ npm i config
• Step1: create a folder and named as config
• create 2 json files to store/get environment variables like:

1. default.json

{
    "jwtPrivateKey": ""
}

2. custom-environment-variables.json

{
    "jwtPrivateKey": "videly_jwtPrivateKey"
}

• Run command to store values on Mac: export videly_jwtPrivateKey=AnyStringHere
• Run command to store values on Windows: set videly_jwtPrivateKey=AnyStringHere
• To retrive result in application as:

const config = require('config');
config.get('jwtPrivateKey')

MiddleWare

A middleware is defined to handle the routs before hitting them. There you can provide a preload conditions. for example:

• Create a middleware folder and create a file as: auth.js

const jwt = require('jsonwebtoken');
const config = require('config');

module.exports = function (req, res, next) {
    const token = req.header('x-auth-token');
    if (!token) return res.status(401).send('Access denied. No token provided.');

    try{
        const decoded = jwt.verify(token, config.get('jwtPrivateKey'));
        req.user = decoded;

        next();
    } catch (ex) {
        res.status(400).send('Invalid token.');
    }
}

• to put in routs, follow this:

// importing
const auth = require('../middleware/auth')

// Applying
router.post('/', auth, async (req, res) => {

express-async-errors

To handle errors just install this library and import it. It'll handle all the errors for example, node module is running but with any reason DB connection has been lost , then it'll handle automatically and give a response. For more detail visit express-async-errors. If it will not work with any reason, you may use your own created middleware technique.

Winston-Mongodb

To generate logs of Mongodb, use winston-mongodb package. For more info Click Here. For official documentation Click here. to install:

npm i winston-mongodb

// Recomended
    "winston": "^2.4.0",
    "winston-mongodb": "^3.0.0"

Tesing Starts from here

Jest

For unint testing, here is used jest library to create mock test. for more info Click here.

To install:

npm i jest --save-dev

go to package.json and update it's script as:

// for unit test
"scripts": {
    "test": "jest --watchAll"
  }
 // for integration and unit test
"scripts": {
    "test": "jest --watchAll --verbose"
  }

SuperTest

To install

npm i supertest --save-dev

With superTest we can send http request to endpoint like a postman. We are running command with --save-de because we need it into Development server. In index.JS make some changes like this:

const server = app.listen(port, () => { winston.info(`Listening to port ${port}`) });

module.exports = server;

Helping Node JS Commands

• npm init --yes
• npm i (install any package like: npm i mongoose)
• npm un (un-install any package like: npm un mongoose)

Helping git commands for github

git init 
git add README.md 
git commit -m "first commit" 
git remote add origin https://github.com/mateenumt027/videly.git 
git push -u origin master