Skip to content

Latest commit

 

History

History
82 lines (55 loc) · 2.66 KB

README.md

File metadata and controls

82 lines (55 loc) · 2.66 KB

Docker Node.js CI Coverage Status Code Smells

Commitizen friendly

Description

Nest service for managing eSamwad Users.

Installation

$ yarn install

Note: This project is built on VSCode and would be developed only with this IDE in mind. The .vscode directory will be kept updated with all the VSCode magic 🧙‍♂️.

Running the app

# development
$ yarn start

# watch mode
$ yarn start:dev

# debug mode
$ yarn start:debug

# production mode
$ yarn start:prod

Test

# unit tests
$ yarn test

# e2e tests
$ yarn test:e2e

# test coverage
$ yarn test:cov

# test a single file
$ yarn run test:watch ./src/user/sms/gupshup/gupshup.service.spec.ts

Add a sample service

# open .env file
$ vi .env

# add your service info in below format
application_id={"host": "dummy.com", "apiKey": "zse12344@#%ddsr", "encryption": {"enabled": true, "key": "veryhardkey"}}
# where apiKey and encryption.key is not mandatory
# Precedence will be given apiKey sent in Authorization header (Check swagger collection below for references)
# encryption.enabled provides option to encrypt username/password with the provided enrption.key before sending to the FA server.

# restart docker-compose
$ docker-compose down
$ docker-compose up -d --build

Postman Collection

Find here

Stay in touch

License

Nest is MIT licensed.

Support

This project was bootstrapped using Nest. 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.