Skip to content

BrewInteractive/nestjs-notification-module

Repository files navigation

Brew Logo

NestJS Notification Module

This package was created to facilitate the use of the Notification Module in NestJS projects

NPM Version Package License NPM Downloads

Instagram Linkedin Twitter

Purpose

This package is developed to be used in NestJS projects. The purpose of the module is to use notification service more easily and effectively in NestJS projects.

Requirements

Variable Name Description Required Default
EMAIL_SERVICE The email service provider to be used Yes -
EMAIL_FROM The sender email address Yes -
EMAIL_SUBJECT Default subject for emails No "Notification"
AWS_SES_REGION AWS SES service region Yes -
AWS_SES_ACCESS_KEY_ID AWS SES access key ID Yes -
AWS_SES_SECRET_ACCESS_KEY AWS SES secret access key Yes -
SMTP_HOST SMTP server address Yes -
SMTP_USER SMTP user name Yes -
SMTP_PASSWORD SMTP password Yes -
SENDGRID_API_KEY SendGrid API key Yes -
SMS_SERVICE The SMS service provider to be used Yes -
MUTLUCELL_USERNAME Mutlucell user name Yes -
MUTLUCELL_PASSWORD Mutlucell password Yes -
MUTLUCELL_ORIGINATOR Mutlucell message sender name (originator) Yes -
MUTLUCELL_API_URL Mutlucell API URL Yes -

Conclusion

These instructions will help you start, configure, test, and use the nestjs-notification-module project.

License

NestJS Plugin Module is MIT licensed.