chore: update readme.md for better devex on windows (#664)

Author: irajAamir

README.md

@@ -1,15 +1,16 @@
 ### A Dockerized Nodejs Express Boilerplate with TypeScript
 
 #### Why
-The main idea behind this app is that, We like you to be focused on your business and not spending hours in project configuration. 
+
+The main idea behind this app is that, We like you to be focused on your business and not spending hours in project configuration.
 
 Give this a try!! We are more than happy to hear your feedback or feature request.
 
 ---
 
 #### About
 
-A comprehensive template. Works out of the box for most Node.js projects with following pieces 
+A comprehensive template. Works out of the box for most Node.js projects with following pieces
 
 - [Docker] as the container service to isolate the environment.
 - [Node.js](Long-Term-Support Version) as the run-time environment to run JavaScript.
@@ -25,27 +26,34 @@ A comprehensive template. Works out of the box for most Node.js projects with fo
 
 #### Features
 
-+ TypeScript
-+ ESLint with some initial rules recommendation
-+ Jest for fast unit testing and code coverage
-+ Type definitions for Node.js and Jest
-+ NPM scripts for common operations
-+ Simple example of TypeScript code and unit test
-+ Example configuration for GitHub Actions
+- TypeScript
+- ESLint with some initial rules recommendation
+- Jest for fast unit testing and code coverage
+- Type definitions for Node.js and Jest
+- NPM scripts for common operations
+- Simple example of TypeScript code and unit test
+- Example configuration for GitHub Actions
 
 ---
 
-### Getting Started
+##### Getting Started
 
 #### Docker
+
 - Clone the repository
 - Run `docker-compose up`
 
 #### Without Docker
+
 - Clone the repository
+
+ You need to install postgreSQL manually for the installation [guide](https://www.enterprisedb.com/downloads/postgres-postgresql-downloads)
+
 - Run `npm install`
-- Run `npm run typeorm migration:run`*
-- Run `npm run watch`
+- Run `npm run typeorm schema:sync`
+- Run `npm run typeorm migration:run`
+- Run `npm i ts-node -g`
+- Run `npm run dev`
 
 \* You need to set environment variables to provide configuration for database connection. Please see `src/config.ts` for environment variable names.
 
@@ -58,14 +66,14 @@ The API will be useable from the documentation available at http://localhost:300
 
 ### Available Scripts
 
-+ `clean` - remove coverage data, Jest cache and transpiled files,
-+ `build` - transpile TypeScript to ES6,
-+ `build:watch` - interactive watch mode to automatically transpile source files,
-+ `lint` - lint source files and tests,
-+ `test` - run tests,
-+ `test:watch` - interactive watch mode to automatically re-run tests
-+ `watch` - automatically restart the application when file changes in the directory are detected
-
+- `clean` - remove coverage data, Jest cache and transpiled files,
+- `build` - transpile TypeScript to ES6,
+- `build:watch` - interactive watch mode to automatically transpile source files,
+- `lint` - lint source files and tests,
+- `test` - run tests,
+- `test:watch` - interactive watch mode to automatically re-run tests
+- `watch` - automatically restart the application when file changes in the directory are detected
 
 ### License
+
 [MIT](/LICENSE)

package-lock.json

@@ -6,8 +6,8 @@
   "scripts": {
     "lint": "eslint . --ext .ts,.tsx --fix",
     "clean": "rimraf coverage build tmp",
-    "dev": "nodemon -e 'yml, yaml, js, ts, tsx, json' -x 'ts-node' src/server.ts | bunyan -o simple",
-    "typeorm": "./node_modules/.bin/ts-node ./node_modules/typeorm/cli.js",
+    "dev": "nodemon -e \"yml, yaml, js, ts, tsx, json\" -x \"ts-node\" src/server.ts | bunyan -o simple",
+    "typeorm":"node --require ts-node/register ./node_modules/typeorm/cli.js" ,
     "compile": "tsc -p tsconfig.release.json",
     "watch:compile": "tsc -w -p tsconfig.release.json",
     "test": "npm run compile && npm run lint && jest --passWithNoTests --runInBand --silent",
@@ -29,34 +29,34 @@
     "@types/express-bunyan-logger": "1.3.3",
     "@types/hapi__joi": "17.1.8",
     "@types/node": "15.6.1",
+    "@types/supertest": "2.0.11",
     "@types/swagger-jsdoc": "6.0.1",
     "@types/swagger-ui-express": "4.1.3",
     "@typescript-eslint/eslint-plugin": "^4.22.1",
     "@typescript-eslint/parser": "^4.22.1",
     "body-parser": "1.19.1",
     "bunyan": "2.0.5",
-    "convict": "6.2.1",
-    "eslint": "^7.25.0",
     "class-transformer": "0.5.1",
     "class-validator": "0.12.2",
+    "convict": "6.2.1",
+    "eslint": "^7.25.0",
     "eslint-import-resolver-node": "^0.3.4",
     "eslint-import-resolver-typescript": "^2.4.0",
     "eslint-plugin-import": "^2.22.1",
     "eslint-plugin-jest": "^25.0.1",
     "express": "4.17.2",
     "express-bunyan-logger": "1.3.3",
     "helmet": "5.0.1",
-    "pg": "8.7.1",
+    "pg": "^8.7.3",
     "reflect-metadata": "^0.1.13",
     "routing-controllers": "0.9.0",
+    "supertest": "6.1.6",
     "swagger-jsdoc": "6.1.0",
     "swagger-ui-express": "4.3.0",
     "ts-node": "10.4.0",
     "typedi": "0.8.0",
-    "typeorm": "0.2.41",
-    "typescript": "4.5.4",
-    "@types/supertest": "2.0.11",
-    "supertest": "6.1.6"
+    "typeorm": "^0.2.41",
+    "typescript": "4.5.4"
   },
   "devDependencies": {
     "@types/jest": "27.4.0",