aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rwxr-xr-x[-rw-r--r--]README.md32
1 files changed, 29 insertions, 3 deletions
diff --git a/README.md b/README.md
index 45ebd4e..d7d200e 100644..100755
--- a/README.md
+++ b/README.md
@@ -1,8 +1,34 @@
-# CPS Temporal Service
+# Building and running CPS Temporal locally
-For now, this repo contains a very minimalist skeleton of the application.
+## Building Java Archive only
-## Local DB setup
+Following command builds Java executable jar to `target/cps-temporal-x.y.z-SNAPSHOT` JAR file
+without generating any docker images:
+
+```bash
+mvn clean install
+```
+
+## Building Java Archive and local Docker image
+
+Following command builds the JAR file and also generates the Docker image:
+
+```bash
+mvn clean install -Pcps-temporal-docker -Ddocker.repository.push=
+```
+
+## Running via Docker Compose
+
+`docker-compose.yml` file is provided to be run with `docker-compose` tool and local image previously built.
+It starts both Postgres Timescale database and CPS Temporal service.
+
+Execute following command from project root folder:
+
+```bash
+docker-compose up -d
+```
+
+## Alternative local db setup
A Postgres instance with Timescale extension can be started by running the following command: