Africa's Talking Messaging MicroService

Description

This is a messaging microservice built on top of Africa's Talking SDK.
This microservice takes care of sending sms to one or many recipients, stores sent messages to a database, handles data validation and much more. The app is made using NodeJS, Express and TypeScript

Table of contents

• Prerequisites
• Directory Structure
• Running Locally
• Acknowledgement
• License

Prerequisites

• NodeJS Installed

• Yarn Package Manager installed. Yarn can be installed using the command below:

npm install --global yarn

• PostgreSQL Installed

Directory-Structure

messaging_microservice
├── src
|   ├── config/             #Application Configurations e.g. database config
|   ├── docs/               #Swagger UI documentation
|   ├── messages/           #Messaging routes, controller, service, middleware and validator
|   └── security/           #DDOS Mitigation
├── .env                    #Environment Variables
├── .gitignore              #git ignore file
├── index.ts                #Application entry point
├── package.json            #Application properties including dependencies
├── README.md
└── tsconfig.json           #TypeScript Configuration

Setting-up-Local-Environment

Without Docker

Step 1

clone the repository and navigate to the project directory

git clone https://github.com/maxwellwachira/messaging_microservice.git
cd messaging_microservice/

Step 2

Check package.json file and ensure scripts are notated as below:

"scripts": {
    "build": "npx tsc",
    "start": "node dist/index.js",
    "dev": "concurrently \"npx tsc --watch\" \"nodemon -q dist/index.js\""
},

Step 3

Delete the node_modules folder and any 'lock' files such as yarn.lock or package-lock.json if present.

Step 4

Run yarn install to install project dependencies

yarn install

Step 5

final step

npm run dev

Acknowledgement

Special thanks to FedhaPap Team - Humprey Shikunzi & Jackline Tum

License