Nest Service

This is a CRUD application that implements user authorization and authentication, error logging, and the use of docker. Postgres is used as a database and Prisma as an ORM

Prerequisites

• Git - Download & Install Git.
• Node.js - Download & Install Node.js and the npm package manager.

Running application

Clone repository

git clone https://github.com/VyacheslavMusiienko/nest-service.git

cd ./nest-service

Installing NPM modules

npm install

Create .env file (based on .env.example)

and you can change port number in .env file

cp .env.example .env

Running application

• Create .env file (based on .env.example) in copied folder: ./.env
• Run next command in your terminal, for building images and docker containers up:

docker-compose up

After docker compose command complete and dockers starting you can open in your browser OpenAPI documentation by typing http://localhost:4000/doc/ (port 4000 as default) and execute test queries.

Scan Vulnerabilities

After build images by command 'docker-compose up'

Run scan image with application

npm run docker:scan:app

Run scan image with PostgresQL

npm run docker:scan:db

After application running open new terminal and enter:

npm run test:auth

After starting the app on port (4000 as default) you can open in your browser OpenAPI documentation by typing http://localhost:4000/doc (only developer mode).

You can download OpenAPI Specification in JSON or YAML format by typing http://localhost:4000/docs-json or http://localhost:4000/docs-yaml (only developer mode)

You will check OpenAPI spec in doc folder corresponds with assignment

For more information about OpenAPI/Swagger please visit https://swagger.io/.