From bd6e3a194f1e249e0f6c5b7316fe5e298cae25fe Mon Sep 17 00:00:00 2001 From: Surabhi Date: Tue, 2 Aug 2022 12:27:36 +0530 Subject: [PATCH] Read me update --- README.md | 34 +++++++++++++++------------------- 1 file changed, 15 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 5977df8..e3b028a 100644 --- a/README.md +++ b/README.md @@ -4,26 +4,22 @@ # Overview Dao holds the dao & repository classes for XMessage. -## Reactive Cassandra Repository -Example using spring boot, and spring data reactive cassandra repository +# Getting Started -## Getting Started +## Prerequisites -### Setup cassandra -1. Get cassandra image -* docker pull cassandra - -2. start cassandra node -* docker run -it --rm --name cassandra-node -p7000:7000 -p7001:7001 -p9042:9042 -p9160:9160 cassandra - -### Run client -* build using mvn clean install -U -* run spring boot application - -### Prerequisites - -* java 8 +* java 11 or above * docker -* cassandra +* kafka +* postgresql +* redis +* fusion auth * lombok plugin for IDE -* maven \ No newline at end of file +* 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