- subscribe a user to the notifications.
- send notification to all the subscribed users, to a specific user or users.
- send sms to all the subscribed users, to a specific user or users. (you have to integrate with an sms provider)
To Run the Project:
- clone the repo or download it
- cd into the directory of the project from the terminal
- copy the content of the private key file you just downloaded into
serviceAccountKey.json
- install all project dependencies with
npm install
- run the project with
npm start
and it will be listening at localhost:3000 - test the project with
npm test
To Run the Service with Docker:
- make sure that docker and docker-compose are installed.
- run
sudo docker-compose up
it will be listening at localhost:3000
The API contains following endpoints
- /subscribe
- /
- /notifications
- /
- /notifications/toAll
- /sms
- /
- /toAll