Notification Service
Project | Technologies | Getting started | Status | Contributing | License
π» Project
This project is a microservice to send notifications, a service responsible for sending notifications to users or other systems. This service is designed to be scalable and flexible, allowing different types of notifications to be sent to different communication channels, such as email, SMS, push notifications, among others.
Notification services are often used in modern applications that require real-time communication with users, such as social networks, messaging applications, e-commerce, task management systems, among others. They can be integrated with other microservices or legacy systems to provide a complete solution for communicating with users.
π Technologies
This project is being developed with the following technologies:
π Getting Started
Prerequisites
Cloning the repository
- You can download this repository or open a Git Bash terminal or a different terminal and copy the code bellow
$ git clone https://github.com/enoquetembe/notifications-service.git
Installation
- Open the project with a terminal and copy the code bellow
$ 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
Status
- This project is still under developement...
π¨βπ» Contributing
Pull Requests are welcome. For major changes, please open an issue to discuss what and which kind of changes you want to perform.
Follow this steps to make your contribution.
1. Fork the repository
2. Create your feature branch
# To make it easier name this branch with your username or with the name of the feature you added
$ git checkout -b MyFeature
3. Commit your changes
$ git commit -m 'Adding my feature'
4. Push to your feature branch
$ git push origin MyFeature
5. Open a Pull Request
Let's work together. π
π License
This project is under MIT Lincese CLICK HERE to read the file about the license.
Made with β€ by Enoque Tembe