Skip to content

Samarth-HP/CDAC-Service

Repository files navigation

CDAC-Service

Build Docker Build Dockerhub Push Quality Gate Status

About 📖

A Spring-Boot based microservice providing REST endpoints for using SMS services provided by CDAC (Centre for Development of Advanced Computing) i.e send single/bulk messages.

Features 🎯

  • Send single unicode message
  • Send bulk messages
  • Send single message
  • Send single unicode message
  • Send otp messages
  • Send messages from CSV
  • Add audit logs

Requirements 📜

  1. Your machine should have Python and pip installed.

Note: Preferable Npm version (3.9.7) and Ubuntu OS version(18.04)*

  1. Check the python and ubuntu version by running following commands.
python --version
lab_release -a

Installation Steps 🚶

1. Fork it 🍴

You can get your own fork/copy of CDAC-SERVICE by using the Fork button.

2. Clone it 👥

You need to clone (download) it to a local machine using

git clone https://github.com/Samagra-Development/CDAC-Service.git

This makes a local copy of the repository in your machine.

Once you have cloned the CDAC-SERVICE repository in GitHub, move to that folder first using the change directory command.

cd CDAC-SERVICE

Move to this folder for all other commands.

3. Set it up ⬆️

First, You need to add the required hosts to your /etc/hosts file as mentioned here on mgov.gov.in website.

Note: These ip addresses are subject to change; so please ensure adding the correct ip addresses. You can use ping utility to identify the ip of a host on your local machine ping msdgweb.mgov.gov.in.

164.100.129.128 mgov.gov.in
164.100.129.141 msdgweb.mgov.gov.in

Run the following commands to see that your local copy has a reference to your forked remote repository in GitHub :octocat:

git remote -v
origin  https://github.com/Your_Username/CDAC-Service.git (fetch)
origin  https://github.com/Your_Username/CDAC-Service.git (push)

4. Run it 🏁

  • rename env.sample file to .env and set the correct variable values
  • build and run the container docker-compose up -d
    docker-compose up -d

5. API

Start the server and go to http://localhost:8080/api/swagger-ui.html