IMFO Backend API

Typescript v2 project with NodeJS + Express + Sequelize ORM. ❤️

[Tech]
[Introduction]
[Up and Running]
- [Local Setup]
  - [Docker Setup] (Pending)
  - [EC2 Instance] (Pending)
[REST API]
- [Endpoints]
[Contributing]

Tech

[node.js] - evented I/O for the backend
[Express] - fast node.js network app framework.
[Mysql] - Sequelize is a promise-based ORM for Node.js
[Sequelize] - In addition, we're going to use Sequelize, which is a database ORM that will interface with the MySQL, PostgreSQL, SQLite, and MariaDB databases for us.

Introduction

Our app directory consists on the following folders

Directory	Description
app/config/	Contains all of your environments, database configuration and middleware configuations.
app/controllers/	Contains all of our endpoints defination.
app/db/migrations	Your database migrations scripts. Keep this files in Javascript and run `npm run db:migrate` to migrate your database schema.
app/models/	Sequelize entities.
app/routes/	Our endpoints listing.

First, define your database schema in config/database.ts file. Use Sequelize CLI to initialize your database.

In models/ directory, the index.ts file define the DbConnection interface. When you create a new Sequelize entity, add its reference in this interface to fully use Typescript's superpower !

Up and Running

Local Setup

Make sure you have Node.js and the [Mysql] installed. Install the dependencies and devDependencies and start the server.

git clone https://github.com/faizanah/TypeScript-Express-Sequelize.git # or clone your own fork
cd TypeScript-Express-Sequelize
npm install # To install NodeJS dependencies.

npm install -g yarn
yarn

The build tasks use Gulp tasks runner. Typescript is transpiled to Javascript in the /build directory. This app use [Mysql] database but you can easily change it and use your favorite relational database (npm or yarn command) :

npm install --save mysql // For both mysql and mariadb dialects
npm install --save sqlite3
npm install --save tedious // MSSQL

Environment Variable setup

Export environment variables through terninals

* export DATABASE_URL="mysql://username:password@host:3306/database"
* export SECRET="My Secret 64bit"
* export NODE_ENV=production
* export PORT=3000

Or rename the /env.example to .env update the values file for your environment

DATABASE_URL=mysql://cffd21a9fqxvl21k:a6p79vk06nnsefb2@c9cujduvu830eexs.cbetxkdyhwsb.us-east-1.rds.amazonaws.com:3306/ovievyi2203s2fab
NODE_ENV=development
SECRET=1234zxcv

The server/config/environment.ts file contain our application environment variables, such as database authentication configuration, secret etc. ..

Be sure to update the server/config/environment.ts file for your development, test, and production environment or add new environmnet variables:

require('dotenv').config();
module.exports = {
   development: {
     DATABASE_URL: 'Test DB Connection String',
     secret: 'Development Secret',
     port: 3000
   },
   test: {
     DATABASE_URL: 'Test DB Connection String',
     secret: 'Testing Secret',
     port: 3000
   },
   production: {
     DATABASE_URL: process.env.DATABASE_URL,
     secret: process.env.SECRET,
     port: process.env.PORT || 3000
   }
 }

If you are just running this locally, using the basic development server, then just update the development config.

Run the project

npm start

Restful API Flow

Signup

Post request to api.example.com/v1/signup/

{
	"firstName": "Faizan",
	"lastName": "Ahmad",
	"email": "faizan.ahmad@virtualforce.io",
	"password": "password"
}

Response

{
    "success": true,
	"data":{
	    "id": '3f5614a0-f4a4-11e8-b6b7-771eeb9fc014',
	    "firstName": "Faizan",
	    "lastName": "Ahmad",
	    "password": "$2a$10$Ze9c2PFdo6DbYtpyJyZJNutymqI71uhOJkkp5ROcPM.ynbG0dyO",
	    "email": "faizan.ahmad@virtualforce.com",
	    "createdAt": "2018-11-30T07:46:19.173Z",
	    "updatedAt": "2019-11-30T07:46:19.173Z"
	},
	 "message": "Congrats! You have Successfully registerd."
 }

Login

Using your account credentials you need to create a session to receive a token to authenticate all other API calls.

Post request toapi.example.com/v1/login/

{
	"email": "faizan.ahmad@virtualforce.io",
	"password": "password"
}

Response

{
    "success": true,
    "data": {
        "id": 4,
        "firstName": "Faizan",
        "lastName": "Ahmad",
        "password": "$2a$10$eKcnjg6J.UdXzO/mwKlfzu.eIp391EDiXEBlO5cHiVAW2IT3Nq",
        "email": "faizan.ahmad@virtualforce.io",
        "createdAt": "2017-09-18T14:16:01.983Z",
        "updatedAt": "2017-09-18T14:16:01.983Z"
    },
    "message": "Congrats! You have successfully login.",
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6ImZhaXphbkBlbmdpbmV0ZWNoLmlvIidsZLyeicvlVN7eWnLuMuOi5E5y-_TYY"
}

To authenticate all the request you need to set the Authoization header -H 'x-access-token: {{token}}' using your token and send this along with your request.

Build

npm run build

Lint your code before you commit!

In a collaborative project, it's always a pain when you have to work on files not correctly formatted. Now beofre each commit, yout typescript files are linted based on your tsconfig.json > .editorconfig > tslint.json files.

λ git commit -m "Example precommit"

> husky - npm run -s precommit

25l[14:22:30] Running tasks for src/**/*.ts [started]
[14:22:30] prettify [started]
[14:22:31] prettify [completed]
[14:22:31] git add [started]
[14:22:31] git add [completed]
[14:22:31] Running tasks for src/**/*.ts [completed]
25h25h[master 23c4321] Example precommit
 1 file changed, 1 insertion(+), 1 deletion(-)

By the way you can also run the command with a npm script

npm run prettify

Roadmap

Add Sequelize Typescript with association
Manage multiple database configuration with NODE_ENV
Add JWT Token based authentication to secure API
Add subdomain api.example.com/v* for API and admin.example.com for Admin Panel
Add Admim Panel UI for Reporting
Add Swagger UI Documentation
Add public pages

vbhakta8 / TypeScript-Express-Sequelize