NestJSApiJsonPlaceHolderUsingJWT

An API to consume JSON Place Holder using REST API concepts in seconds with NestJS 9.x and Passport Auth JWT System and Rate Limit.

Installation

   $ npm install

Set Enviroment for secret key JWT and other configurations

   $ cp .env.example .env

To set up on multiple environments, such as dev, stage or prod, we do as follows:

   $ cp .env.example .env.dev # or .env.stage, etc

For more info access: https://docs.docker.com/get-started/

Install TypeScript Node

   $ npm install -g ts-node

Docker

Install docker on windows.

$ choco install docker-cli

Install docker on Ubuntu.

apt get update

$ sudo apt-get update

install

$ sudo apt-get install docker-ce docker-ce-cli containerd.io docker-compose-plugin

Start it

$ sudo systemctl start docker

Install docker on Mac with Brew

$ brew install --cask docker

Install docker on windows.

$ choco install docker-cli

Running the app

There is a docker-compose.yml file for starting mongoDB and Redis with Docker.

$ docker compose up

After running, you can stop the Docker container with

$ docker compose down

Url Swagger for Api Documentation

http://localhost:3000/api/swagger

Configure SWAGGER_USER and SWAGGER_PASSWORD in the .env file and set NODE_ENV to local or devor staging to access the SWAGGER(Open Api) documentation with basic authentication.

NODE_ENV=[:enviroments]
SWAGGER_USER=[:user]
SWAGGER_PASSWORD=[:password]

If you want to add more environments, include them in the SWAGGER_ENVS array in main.ts, see the following:

const SWAGGER_ENVS = ['local', 'dev', 'staging'];

Configuring the NODE_API_PORT environment variable as the default port if you don't want to use the default

   NODE_API_PORT=3000

Running tests using jest

$ npm test

Check code coverage using:

$ npm run test:cov