Home Library Service

Prerequisites

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

Downloading

git clone {repository URL}

Installing NPM modules

npm install

Running application

npm start

After starting the app on port (4000 as default) you can open in your browser OpenAPI documentation by typing http://localhost:4000/doc/. For more information about OpenAPI/Swagger please visit https://swagger.io/.

To get OpenAPI in json format open http://localhost:4000/doc-json To get OpenAPI in yaml format open http://localhost:4000/doc/yaml

You can change port by copying .env.example file to .env file and changing variable PORT to new value

Testing

After application running open new terminal and enter:

To run all tests without authorization

npm run test

To run only one of all test suites

npm run test -- <path to suite>

To run all test with authorization

npm run test:auth

To run only specific test suite with authorization

npm run test:auth -- <path to suite>

Auto-fix and format

npm run lint

npm run format

Debugging in VSCode

Press F5 to debug.

For more information, visit: https://code.visualstudio.com/docs/editor/debugging