docker integration

Author: roshmadosh

.gitignore

@@ -41,3 +41,5 @@ out/
 
 ### Logs ###
 logs/
+
+**/application-prod.properties

Dockerfile

@@ -0,0 +1,6 @@
+FROM openjdk:11
+VOLUME /tmp
+EXPOSE 8080
+ARG JAR_FILE=build/libs/kaput-0.0.1-SNAPSHOT.jar
+ADD ${JAR_FILE} app.jar
+ENTRYPOINT ["java", "-jar", "/app.jar"]

README.md

@@ -4,22 +4,24 @@
 The app is named after the sound my car makes, which I'm hoping to replace once 
 I no longer need to use such an app.  
 
-Requirements:
-- Java 11 or Newer
-- PostgreSQL v14+ (will replace once Docker set up)
+## Setup
 
-You will have to first create a database named `kaput` in PostgreSQL, then update the DB credentials 
-in `build.gradle` (under the liquibase task) and `application.properties`.  
+Requirements:
+- [Docker](https://docs.docker.com/get-docker/) Engine version 19.03.0+
+- [Docker Compose](https://docs.docker.com/compose/install/)
 
-With the DB created and credentials updated, Liquibase should read `changelog-root.xml` to initialize the 
-tables and data for you.
+Steps:
+1. Run `docker compose up`. This starts two docker instances: one for the app and another for PostgreSQL.  
+2. Then find the container id for the docker container with image name `kaput-api`.  
+3. Find the IP address this container is running on with `docker container inspect <the container id>`. This is the host where you will send requests to on port 8080 (e.g. http://\<container ip address\>:8080/api/users).  
 
-Run locally by executing the command `gradlew runBoot` from the project root directory. Once the app is up and 
-running, go to `localhost:8080` from a browser.  
+Will update Swagger docs with instructions on how to use API.  
 
+## ERD
 Only two entites are needed for this application.  
-![entity-relationship diagram](./img/erd.png)
+![entity-relationship diagram](./img/erd.png)  
 
+##Notes  
 ### Exception Handling
 Exception handling is composed of two parts:
 1. Providing a custom exception response body

docker-compose.yaml

@@ -0,0 +1,23 @@
+version: '3.8'
+
+services:
+  app:
+    image: 'kaput-api:latest'
+    build:
+      context: .
+    container_name: app
+    depends_on:
+      - db
+    environment:
+      - SPRING_DATASOURCE_URL=jdbc:postgresql://db:5432/kaput
+      - SPRING_DATASOURCE_USERNAME=postgres
+      - SPRING_DATASOURCE_PASSWORD=password
+      - SPRING_JPA_HIBERNATE_DDL_AUTO=update
+
+  db:
+    image: 'postgres:14.7-alpine'
+    container_name: db
+    environment:
+      - POSTGRES_USER=postgres
+      - POSTGRES_PASSWORD=password
+      - POSTGRES_DB=kaput

src/main/resources/config/application-dev.properties

@@ -1,4 +1,5 @@
-spring.jpa.properties.hibernate.dialect = org.hibernate.dialect.PostgreSQLDialect
+spring.jpa.show-sql=true
+spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.PostgreSQLDialect
 spring.jpa.hibernate.ddl-auto=update
 spring.jpa.hibernate.show-sql=true
 spring.datasource.url=jdbc:postgresql://localhost:5432/kaput

src/main/resources/config/application.properties

@@ -1,3 +1,4 @@
+server.address=0.0.0.0
 spring.liquibase.change-log=classpath:db/changelog-root.xml
 spring.liquibase.databaseChangeLogTable=changelogs
 java.lang.NoSuchMethodError: 'java.lang.String ch.qos.logback.core.util.EnvUtil.logbackVersion()'