📝 document docker usage

josuablejeru · Aug 27, 2023 · beaaaeb · beaaaeb
1 parent 8aae749
commit beaaaeb
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -3,15 +3,35 @@
 this api is a small demo app to see how a stock resupply
 Mobile app might work for a small Mom & Pop's shop using Odoo.
 
+![swaggerui](assets/swagger.png)
+
 ## Tools used
 
 - Spring Boot
 - Postgres
 - Swagger UI / OpenAPI 3.0
 
+## Docker Compose
+```yaml
+services:
+  postgres:
+    image: 'postgres:latest'
+    environment:
+      - 'POSTGRES_DB=mydatabase'
+      - 'POSTGRES_PASSWORD=secret'
+      - 'POSTGRES_USER=myuser'
+    ports:
+      - '5432:5432'
+
+  backend:
+    image: ghcr.io/josuablejeru/resupply-api:latest
+    ports:
+      - '8080:8080![swagger.png](swagger.png)'
+```
+
 ## Development
 
 Endpoints:
 
 - [Swagger UI](http://localhost:8080/swagger-ui/index.html)
-- [OpenAPI 3.0](http://localhost:8080/v1/docs)
+- [OpenAPI 3.0](http://localhost:8080/v1/docs)
diff --git a/assets/swagger.png b/assets/swagger.png