Getting Started

Prerequisites

Lombok for IDE

Install lombok plugin for your IDE (Recommended IDE - Intellij IDEA Community Edition). Refer to Lombok site for installation instructions

Docker Compose

Refer to Docker site for installation instructions

Vault

Refer to Vault site for installation instructions

MySQL 5.7

Refer to MySQL site for installation instructions

---

Setup

1. Download the latest starter project source code from Releases section or clone this repository

2. Extract the source code and then open terminal/console in your working directory

3. Run cd engine/ && ./gradlew clean build for linux or cd engine\ && gradlew.bat clean build for windows. This will generate engine/build/libs/engine-1.0.0.jar file which is used by gradle to build serve microservices

4. Import serve/ as a gradle project into IDE. In case of Intellij, check following boxes while importing project : Use auto-import and create directories for empty content roots automatically

5. Run cd ../serve/ && ./gradlew clean build using linux terminal or cd ..\serve\ && gradlew.bat clean build on windows console

---

Running microservices manually

Running using docker

1. Verify docker compose is installed by running following command docker-compose --version