Merge pull request #7 from dockersamples/add-web-demo-client

Add web demo client

README.md

@@ -49,6 +49,8 @@ To start the app, follow these steps:
    yarn dev
    ```
 
+4. Once everything is up and running, you can open the demo client at http://localhost:5173
+
 ### Debugging the application
 
 The project contains configuration for VS Code to enable quick debgging. Once the app is running, you can start a debug session by using the **Debug** task in the "Run and Debug" panel. This currently only works when the app is running natively on the machine.
@@ -84,6 +86,7 @@ $ yarn integration-test
 
 Once the development environment is up and running, the following URLs can be leveraged:
 
+- [http://localhost:5173](http://localhost:5173) - a simple React app that provides the ability to interact with the API via a web interface (helpful during demos)
 - [http://localhost:5050](http://localhost:5050) - [pgAdmin](https://www.pgadmin.org/) to visualize the database. Login using the password `postgres` (configured in the Compose file)
 - [http://localhost:8080](http://localhost:8080) - [kafbat](https://github.com/kafbat/kafka-ui) to visualize the Kafka cluster
 

compose.yaml

@@ -1,4 +1,12 @@
 services:
+  demo-client:
+    image: node:lts-slim
+    working_dir: /usr/local/app
+    command: yarn dev
+    ports:
+      - 5173:5173
+    volumes:
+      - ./dev/webapp:/usr/local/app
 
   ############## DATABASE AND VISUALIZER ##############
   postgres:

dev/db/1-create-schema.sql

@@ -2,5 +2,6 @@ CREATE TABLE products (
   id SERIAL PRIMARY KEY,
   name VARCHAR(255) NOT NULL,
   upc VARCHAR(12) NOT NULL UNIQUE,
-  price DECIMAL(10, 2) NOT NULL
+  price DECIMAL(10, 2) NOT NULL,
+  has_image BOOLEAN NOT NULL DEFAULT FALSE
 );

dev/inventory-mocks/mappings/inventory1.json

@@ -0,0 +1,16 @@
+{
+  "request": {
+    "method": "GET",
+    "url": "/api/inventory?upc=100000000001"
+  },
+  "response": {
+    "status": 200,
+    "jsonBody": {
+      "id": 1231,
+      "quantity": 12
+    },
+    "headers": {
+      "Content-Type": "application/json"
+    }
+  }
+}

dev/scripts/replace-file.sh

@@ -0,0 +1,10 @@
+#!/bin/bash
+
+id=$1
+
+if [ -z "$id" ]; then
+  echo "id is not set. Exiting..."
+  exit 1
+fi
+
+aws --endpoint=http://localhost:4566 s3 cp product-image.png s3://product-images/${id}/product.png

dev/scripts/upload-file.sh

@@ -7,4 +7,4 @@ if [ -z "$id" ]; then
   exit 1
 fi
 
-curl -F "file=@docker-logo-blue.png" "http://localhost:3000/api/products/${id}/image"
+curl -F "file=@product-image.png" "http://localhost:3000/api/products/${id}/image"

dev/webapp/.gitignore

@@ -0,0 +1,24 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?

dev/webapp/README.md

@@ -0,0 +1,8 @@
+# React + Vite
+
+This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+
+Currently, two official plugins are available:
+
+- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
+- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh

dev/webapp/eslint.config.js

@@ -0,0 +1,38 @@
+import js from "@eslint/js";
+import globals from "globals";
+import react from "eslint-plugin-react";
+import reactHooks from "eslint-plugin-react-hooks";
+import reactRefresh from "eslint-plugin-react-refresh";
+
+export default [
+  { ignores: ["dist"] },
+  {
+    files: ["**/*.{js,jsx}"],
+    languageOptions: {
+      ecmaVersion: 2020,
+      globals: globals.browser,
+      parserOptions: {
+        ecmaVersion: "latest",
+        ecmaFeatures: { jsx: true },
+        sourceType: "module",
+      },
+    },
+    settings: { react: { version: "18.3" } },
+    plugins: {
+      react,
+      "react-hooks": reactHooks,
+      "react-refresh": reactRefresh,
+    },
+    rules: {
+      ...js.configs.recommended.rules,
+      ...react.configs.recommended.rules,
+      ...react.configs["jsx-runtime"].rules,
+      ...reactHooks.configs.recommended.rules,
+      "react/jsx-no-target-blank": "off",
+      "react-refresh/only-export-components": [
+        "warn",
+        { allowConstantExport: true },
+      ],
+    },
+  },
+];

dev/webapp/index.html

@@ -0,0 +1,12 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Demo client</title>
+  </head>
+  <body>
+    <div id="root"></div>
+    <script type="module" src="/src/main.jsx"></script>
+  </body>
+</html>

dev/webapp/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "webapp",
+  "private": true,
+  "version": "0.0.0",
+  "type": "module",
+  "scripts": {
+    "dev": "yarn install && vite --host 0.0.0.0",
+    "build": "vite build",
+    "lint": "eslint .",
+    "preview": "vite preview"
+  },
+  "dependencies": {
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.15.0",
+    "@types/react": "^18.3.12",
+    "@types/react-dom": "^18.3.1",
+    "@vitejs/plugin-react": "^4.3.4",
+    "eslint": "^9.15.0",
+    "eslint-plugin-react": "^7.37.2",
+    "eslint-plugin-react-hooks": "^5.0.0",
+    "eslint-plugin-react-refresh": "^0.4.14",
+    "globals": "^15.12.0",
+    "vite": "^6.0.1"
+  }
+}

dev/webapp/src/App.css

@@ -0,0 +1,23 @@
+#root {
+  max-width: 1280px;
+  margin: 0 auto;
+  padding: 2rem;
+  text-align: center;
+}
+
+table {
+  border-collapse: collapse;
+}
+
+table thead tr th {
+  border-bottom: 1px solid #ccc;
+}
+
+table tbody td {
+  padding: 0.5rem 1rem;
+  font-size: 0.9rem;
+}
+
+td img {
+  max-height: 60px;
+}

dev/webapp/src/App.jsx

@@ -0,0 +1,80 @@
+import { useCallback, useEffect, useState } from "react";
+import "./App.css";
+import { ProductRow } from "./ProductRow";
+
+function App() {
+  const [lastRequest, setLastRequest] = useState(null);
+  const [catalog, setCatalog] = useState(null);
+
+  const fetchCatalog = useCallback(() => {
+    fetch("/api/products")
+      .then((response) => response.json())
+      .then((data) => {
+        setCatalog(data);
+        setLastRequest({
+          method: "GET",
+          url: "/api/products",
+          status: 200,
+          response: data,
+        });
+      });
+  }, []);
+
+  const createProduct = useCallback(() => {
+    const body = {
+      name: "New Product",
+      price: 100,
+      upc: 100000000000 + catalog.length + 1,
+    };
+
+    fetch("/api/products", {
+      method: "POST",
+      headers: { "Content-Type": "application/json" },
+      body: JSON.stringify(body),
+    }).then(fetchCatalog);
+  }, [catalog, fetchCatalog]);
+
+  useEffect(() => {
+    fetchCatalog();
+  }, [fetchCatalog]);
+
+  return (
+    <>
+      <h1>Demo catalog client</h1>
+
+      <p>
+        <button onClick={fetchCatalog}>Refresh catalog</button>
+        &nbsp;
+        <button onClick={createProduct}>Create product</button>
+      </p>
+
+      {catalog ? (
+        <table>
+          <thead>
+            <tr>
+              <th>ID</th>
+              <th>Name</th>
+              <th>Price</th>
+              <th>UPC</th>
+              <th>Inventory</th>
+              <th>Image</th>
+            </tr>
+          </thead>
+          <tbody>
+            {catalog.map((product) => (
+              <ProductRow
+                key={product.id}
+                product={product}
+                onChange={() => fetchCatalog()}
+              />
+            ))}
+          </tbody>
+        </table>
+      ) : (
+        <p>Loading catalog...</p>
+      )}
+    </>
+  );
+}
+
+export default App;

dev/webapp/src/ProductRow.jsx

@@ -0,0 +1,64 @@
+import { useCallback, useState } from "react";
+import productImage from "./product-image.png";
+
+export function ProductRow({ product, onChange }) {
+  const [inventoryDetails, setInventoryDetails] = useState(null);
+
+  const fetchInventoryDetails = useCallback(() => {
+    fetch(`/api/products/${product.id}`)
+      .then((response) => response.json())
+      .then(({ inventory }) => setInventoryDetails(inventory))
+      .then(() => onChange());
+  }, [setInventoryDetails]);
+
+  const uploadImage = useCallback(() => {
+    fetch(productImage)
+      .then((r) => r.blob())
+      .then((fileBlob) => {
+        const file = new File([fileBlob], "product-image.png", {
+          type: "image/png",
+        });
+
+        const formData = new FormData();
+        formData.append("file", file);
+
+        fetch(`/api/products/${product.id}/image`, {
+          method: "POST",
+          body: formData,
+        }).then(() => onChange());
+      });
+  }, []);
+
+  return (
+    <tr>
+      <td>{product.id}</td>
+      <td>{product.name}</td>
+      <td>{product.price}</td>
+      <td>{product.upc}</td>
+      <td>
+        {inventoryDetails ? (
+          <>
+            {inventoryDetails.error ? (
+              <span className="error">{inventoryDetails.message}</span>
+            ) : (
+              <span>{inventoryDetails.quantity}</span>
+            )}
+          </>
+        ) : (
+          <button className="smaller" onClick={fetchInventoryDetails}>
+            Fetch
+          </button>
+        )}
+      </td>
+      <td>
+        {product.has_image ? (
+          <img src={`/api/products/${product.id}/image`} alt={product.name} />
+        ) : (
+          <button className="smaller" onClick={uploadImage}>
+            Upload
+          </button>
+        )}
+      </td>
+    </tr>
+  );
+}