Merge pull request #43 from jaredwray/feat-adding-in-docker-compose-example

feat: adding in docker compose example

Author: jaredwray

README.md

@@ -24,6 +24,29 @@ A simple HTTP server that can be used to mock HTTP responses for testing purpose
 docker run -d -p 3000:3000 jaredwray/mockhttp
 ```
 
+# Deploy via Docker Compose
+```yaml
+services:
+  mockhttp:
+    image: jaredwray/mockhttp:latest
+    ports:
+      - "3000:3000"
+```
+
+If you want to run it on a different port, just change the `3000` to whatever port you want and add in the environment variable `PORT` to the environment.
+
+```yaml
+services:
+  mockhttp:
+    image: jaredwray/mockhttp:latest
+    ports:
+      - "3001:3001"
+    environment:
+      - PORT=3001
+```
+
+You can see an example of this in the [docker-compose.yaml](docker-compose.yaml) file.
+
 # Deploy via NodeJS
 ```bash
 npm install @jaredwray/mockhttp --save

docker-compose.yaml

@@ -0,0 +1,7 @@
+services:
+  mockhttp:
+    image: jaredwray/mockhttp:latest
+    ports:
+      - "3001:3001"
+    environment:
+      - PORT=3001

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jaredwray/mockhttp",
-  "version": "0.4.1",
+  "version": "0.4.2",
   "description": "Mock Http - Easy way to mock http with httpbin replacement",
   "type": "module",
   "main": "dist/index.js",
@@ -16,6 +16,8 @@
     "docker:push": "docker push jaredwray/mockhttp",
     "docker:stop": "docker stop $(docker ps -a -q --filter ancestor=jaredwray/mockhttp --format=\"{{.ID}}\")",
     "docker:readme": "tsx ./scripts/create-docker-readme.ts",
+    "docker:compose:up": "docker-compose up -d",
+    "docker:compose:down": "docker-compose down",
     "prepare": "pnpm build",
     "start": "node dist/index.js"
   },