README.md

Prerequisites

You need to have NodeJs, PostgreSQL and Git installed before running this project.

API Documentation

You need to install postman first.

Then:

• Open postman
• import collection
• select the file "API documentation.postman_collection.json"
• right click on the new collection that appeared
• view documentation

Installing Nest CLI

$ npm install -g @nestjs/cli

Clone Repository

$ git clone https://github.com/MahmoudMNael/order-management-system.git

Installing required packages

$ npm install

Setup your environment

Create .env file in your project root directory

Add variables:

• DATABASE_URL with the database connection string
• JWT_SECRET with the secret key of your jwt tokens

Run database migration

$ npx prisma migrate dev
$ npx prisma db seed

Running the app

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Test

# e2e tests
$ npm run test:e2e