BANK_API_With_SwaggerDoc

The Swagger API Documention gives full explanation and guide on how to use the API.

To get started running the code on your system locally -

tools required (to download)

mongo compass(offline) or mongo Atlas cloud (online)

node (version recommended)

postman to test the api (optional). You can use swagger documentation link to test it too.

open the project on your editor (preferrably VS Code)

cd to bankApi (the folder name)

run "npm install" on your terminal to downlaod all dependencies

Install nodemon to run the app.js automatically. To install nodemon use, "npm install -g nodemon"

Once you cd to the the folder, run the app.js

To run it use - "nodemon app.js"

It runs on localhost:4000

Go to your chrome/brave browser or postman, on your url, run "http://localhost:4000"

Once it display an object json, then you are good to go.

To get the documentation with the swagger documentation, use the link: http://localhost:4000/bankApi

A progressive Node.js framework for building efficient and scalable server-side applications.

Description

Nest framework TypeScript starter repository.

Installation

$ npm install

Running the app

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

Support

Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please read more here.

Stay in touch

• Author - Kamil Myśliwiec
• Website - https://nestjs.com
• Twitter - @nestframework

License

Nest is MIT licensed.