simplusinnov/notification-microservice repository overview

⁠notification-microservice - API

Unilever api responsible for manage and computing all api required on the application.

⁠Usage

⁠Developers

⁠Prerequites

Before installing, the following prerequisites need to met:

• Docker⁠ needs to be installed on the host server.
• default bridge network bridge network⁠ needs to be created using docker on the host server to link dashboar API.
• git⁠ needs to be installed on the host server.
• ssh⁠ key from Simplus development team to allow for cloning onto the host server.
• npm token⁠ from Simplus development team to allow for installing private npm packages.

⁠Installation

1. clone solution To install the solution, first clone the repo to the host server

   git clone [email protected]:simplusinnovation//notification-microservice.git
   

   Copy

   In some cases, you may need to activate your ssh-agent to link your local private key to the command in the following manner:

   eval $(ssh-agent -s) && $(ssh-add /path/to/your/.ssh/id_rsa; git pull [email protected]:simplusinnovation//notification-microservice.git)
   

   Copy

2. build docker container (skip this part as its build automatically using dockerhub and watchtower) move to cloned folder.

   cd /notification-microservice
   

   Copy

   build docker container by passing the npm token as a build parameter.

   sudo docker build -t api:unilever --build-arg NPM_SECRET=<npm token> .
   

   Copy

3. run the container run the container using the --net flag, linking the container to the bridge network on server.

   sudo docker run --net 'bridge' -p 3005:3002 -d --name unilever --restart always api:unilever
   

   Copy

4. test server open http://localhost:3005/api/v1/ping⁠ in your browser.

⁠Technical users

⁠Issues

Any issues found on usage of this solution (more especially failed tests found on test status of solution), post your issues onto the corresponding unilever API page:

• Collection⁠