From fbdafc229e4759745d8cdd97cf687c54e26b26b0 Mon Sep 17 00:00:00 2001 From: Surabhi Date: Tue, 2 Aug 2022 12:32:39 +0530 Subject: [PATCH] Read me update --- README.md | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a99a9a0..a212b76 100644 --- a/README.md +++ b/README.md @@ -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. \ No newline at end of file +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) \ No newline at end of file