README.md

Steps To run localy on your machine and development mode

after clone this repo follow:

craete an enviroment file (.env)

1- rename the ( .env.example ) file to be .env
2- add required connection for your DB variable. here using (postgreSQL)

Installation

$ npm install

Building the app

$ npm run build

Running the app

# watch mode
$ npm run start:dev

To view APIs Documentation and Test Inputs/Outputs

• open in your browser while project is running [http://localhost:3000/api] for swagger.

Running Migrations

Hint: first check in db.config.ts file for typeorm config ( synchronize: true )

it must be false to run migration successfully.

1- run build app script

$ npm run build

2- run migration script

$ npm run db:run

Docker

$ docker-compose up