Merge pull request #7 from nabadeep25/dev

Documentation and refactor

Author: nabadeep25

.env.example

@@ -2,7 +2,7 @@ DB_HOST=localhost
 DB_NAME=name
 DB_PASSWORD=password
 DB_PORT=3306
-DB_TYPE=mysql
+DB_TYPE=postgres
 DB_USER=username
 PORT=5000
 

README.md

@@ -29,7 +29,7 @@ A boilerplate/starter project for quickly building RESTful APIs using Node.js,Ty
 
 create boillerplate with single command
 
-```
+```sh
  npx  @nabadeep25/create-ts-node-app myapp
 
 ```
@@ -42,7 +42,7 @@ steps:
 
 Clone the repo:
 
-```
+```sh
 git clone --depth 1 https://github.com/nabadeep25/typescript-node-sequelize-boilerplate.git  foldername
 
 cd folder name
@@ -51,19 +51,19 @@ npx rimraf ./.git
 
 Install the dependencies:
 
-```
+```sh
 npm install
 ```
 
 Set the environment variables:
 
-```
+```sh
 cp .env.example .env
 
 ```
 ## Getting started
 
-```
+```sh
 npm install
 
 npm run build-ts
@@ -74,20 +74,20 @@ npm start
 
 ## For development
 
-```
+```sh
 npm install
 
-npm run watch
+npm run dev
 
 ```
 
 ## Sample .ENV
-```
+```sh
 DB_HOST=localhost
 DB_NAME=name
 DB_PASSWORD=password
 DB_PORT=3306
-DB_TYPE=mysql
+DB_TYPE=postgres
 DB_USER=username
 PORT=5000
 
@@ -114,7 +114,7 @@ OTP_SECRET=shgdbnbgw
 
 ```bash
 # run in development
-npm run watch
+npm run dev
 
 # run in production
 npm run start
@@ -147,7 +147,31 @@ src\
  |--app.ts\         # Express app
  |--server.ts\      # App entry point
 ```
-
+## Changing Database
+
+### step 1
+ 
+ ```sh
+ # Change the value of  DB_TYPE  in .env file to one of the follwing
+ DB_TYPE=postgres 
+ DB_TYPE=mysql 
+ DB_TYPE=sqlite 
+ DB_TYPE=mariadb 
+ DB_TYPE=mssql 
+ DB_TYPE=db2 
+ DB_TYPE=oracle 
+ ```
+### step 2
+```sh
+# Install one of the related packge:
+ npm install --save pg pg-hstore # for Postgres
+ npm install --save mysql2 # for Mysql
+ npm install --save mariadb # for Mariadb
+ npm install --save sqlite3 # for Sqlite
+ npm install --save tedious # for Microsoft SQL Server (mssql)
+ npm install --save oracledb # for Oracle 
+```
+for more details please refer [Sequelize](https://sequelize.org/docs/v6/getting-started/)
 ## API Documentation
 
 To view the list of available APIs and their specifications, run the server and go to `http://localhost:5000/api/v1/docs` in your browser. This documentation page is automatically generated using the [swagger](https://swagger.io/) definitions written as comments in the route files.
@@ -156,16 +180,20 @@ To view the list of available APIs and their specifications, run the server and
 
 List of available routes:
 
-**Auth routes**:
-`POST api/v1/auth/register` - register
-`POST api/v1/auth/login` - login
-`POST api/v1/auth/forgot-password` - send reset password email
-`POST api/v1/auth/reset-password` - reset password
+**General routes**: <br>
+`GET api/` - get server status <br>
+`PATCH api/sync` - Sync model with database <br>
+
+**Auth routes**:  <br>
+`POST api/v1/auth/register` - register <br>
+`POST api/v1/auth/login` - login <br>
+`POST api/v1/auth/forgot-password` - send reset password email <br>
+`POST api/v1/auth/reset-password` - reset password <br>
 
 
-**User routes**:
-`GET api/v1/user` - get user info
-`PATCH api/v1/user` - update user
+**User routes**: <br>
+`GET api/v1/user` - get user info <br>
+`PATCH api/v1/user` - update user <br>
 
 
 

src/app.ts

@@ -1,6 +1,6 @@
 import express from "express";
 import logger from "morgan";
-import dbInit from "./db/init";
+import {dbSync} from "./db/connection";
 import cors from "cors";
 import { customRequest } from "./types/customDefinition";
 import { deserializeUser } from "./middleware";
@@ -38,7 +38,7 @@ app.get("/api/", (req: customRequest, res) => {
  */
 app.patch("/api/sync", async (req, res) => {
   try {
-    const sync = await dbInit();
+    const sync = await dbSync();
     res.status(200).json({ ...sync, error: false });
   } catch (err) {
     console.log("ERR", err);

src/db/connection.ts

@@ -1,6 +1,8 @@
 import { Sequelize } from "sequelize";
-
 import { dbConfig } from "../config/config";
+import logger from "../util/logger";
+
+const isDev = process.env.NODE_ENV === "development";
 
 const sequelizeConnection = new Sequelize(
   dbConfig.database,
@@ -10,7 +12,26 @@ const sequelizeConnection = new Sequelize(
     host: dbConfig.host,
     port: dbConfig.port,
     dialect: dbConfig.dialect,
+    logging: msg => logger.debug(msg),
   }
 );
 
+const dbSync = async () => {
+  try {
+    await sequelizeConnection.sync({ alter: isDev });
+    return { success: true };
+  } catch (error) {
+    throw error;
+  }
+};
+dbSync()
+  .then(res => {
+    logger.info(`DB sync with status: ${res.success}`);
+  })
+  .catch(err => {
+    logger.error("Failed to sync DB", err);
+  });
+
+export { dbSync };
+ 
 export default sequelizeConnection;