Fix: Major spring image build failure and updated README.md

AbhishekChd · Aug 31, 2023 · b576d46 · b576d46
1 parent e82d3e2
commit b576d46
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 0 deletions.
diff --git a/Dockerfile b/Dockerfile
@@ -5,6 +5,7 @@ VOLUME /tmp
 # Copy all the source files
 COPY ./gradle ./gradle
 COPY gradlew build.gradle ./
+COPY settings.gradle ./
 COPY ./qeatsbackend/src ./qeatsbackend/src
 COPY ./qeatsbackend/build.gradle ./qeatsbackend/build.gradle
 COPY ./assets ./assets

diff --git a/README.md b/README.md
@@ -11,3 +11,21 @@ Built a distributed system backend for food order platform, QEats, with **Java S
 - `AddItem`
 - `DeleteItem`
 - `PlaceOrder`
+
+![Postman API Docs](assets/postman_api_docs.png)
+<h4 align="center"> Postman API Docs </h4>
+
+## Installation
+
+> Make sure you have [Docker](https://docs.docker.com/get-docker/) installed and running
+
+1. Go to [qeats/Packages](https://github.com/AbhishekChd/qeats/pkgs/container/qeats)
+2. Download latest version like: `docker pull ghcr.io/abhishekchd/qeats:latest`
+3. Create a `.env` file to define `LATITUDE` and `LONGITUDE` to localize data
+4. Run: `docker compose -f docker-compose.yml -p qeats up -d`
+5. Open: [localhost:8080/swagger-ui.html](localhost:8080/swagger-ui.html#/)
+
+
+![Swagger UI](assets/swagger_ui.png)
+<h4 align="center"> Swagger UI </h4>
+
diff --git a/assets/postman_api_docs.png b/assets/postman_api_docs.png
diff --git a/assets/swagger_ui.png b/assets/swagger_ui.png