Skip to content

Commit

Permalink
Read me update
Browse files Browse the repository at this point in the history
  • Loading branch information
surabhi-mahawar committed Aug 2, 2022
1 parent 3583e46 commit fbdafc2
Showing 1 changed file with 21 additions and 1 deletion.
22 changes: 21 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,24 @@
![Docker Build](https://github.com/samagra-comms/outbound/actions/workflows/docker-build-push.yml/badge.svg)

# Overview
Outbound converts the xMessage to the one that will be sent to the channel(sms/whatsapp). It will then be sent to the network provider(Netcore/Gupshup) who will send it to the channel.
Outbound converts the xMessage to the one that will be sent to the channel(sms/whatsapp). It will then be sent to the network provider(Netcore/Gupshup) who will send it to the channel.

# Getting Started

## Prerequisites

* java 11 or above
* docker
* kafka
* postgresql
* redis
* fusion auth
* lombok plugin for IDE
* maven

## Build
* build with tests run using command **mvn clean install -U**
* or build without tests run using command **mvn clean install -DskipTests**

# Detailed Documentation
[Click here](https://uci.sunbird.org/use/developer/uci-basics)

0 comments on commit fbdafc2

Please sign in to comment.