Added Sample: WebApi with Express.js and EventStoreDB

.github/workflows/build_and_test.yml

@@ -4,8 +4,20 @@ on:
   # run it on push to the default repository branch
   push:
     branches: [main]
+    paths:
+      - "src/**"
+      - "!src/docs/**"
+      - "!src/.vscode/**"
+
   # run it during pull request
   pull_request:
+    paths:
+      - "src/**"
+      - "!src/docs/**"
+      - "!src/.vscode/**"
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
 
 defaults:
   run:

.github/workflows/build_and_test_sample_webapi-expressjs-with-esdb.yml

@@ -0,0 +1,54 @@
+name: Build and test Sample - WebApi with Express.js and EventStoreDB
+
+on:
+  # run it on push to the default repository branch
+  push:
+    branches: [main]
+    paths:
+      - "samples/webApi/expressjs-with-esdb"
+      - "!src/.vscode/**"
+
+  # run it during pull request
+  pull_request:
+    paths:
+      - "samples/webApi/expressjs-with-esdb"
+      - "!src/.vscode/**"
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+defaults:
+  run:
+    working-directory: ./src/samples/webApi/expressjs-with-esdb
+
+jobs:
+  build-and-test-code:
+    name: Build application code
+    # use system defined below in the tests matrix
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check Out Repo
+        uses: actions/checkout@v4
+
+      - name: Use Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: ./src/samples/webApi/expressjs-with-esdb/.nvmrc
+          cache: "npm"
+          cache-dependency-path: "./src/samples/webApi/expressjs-with-esdb/package-lock.json"
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build TS
+        run: npm run build:ts
+
+      - name: Run linting (ESlint and Prettier)
+        run: npm run lint
+
+      - name: Build
+        run: npm run build
+
+      - name: Test
+        run: npm run test

samples/webApi/expressjs-with-esdb/.editorconfig

@@ -0,0 +1,5 @@
+# Editor configuration, see http://editorconfig.org
+root = true
+
+[*]
+end_of_line = lf

samples/webApi/expressjs-with-esdb/.eslintignore

@@ -0,0 +1,11 @@
+/node_modules/*
+# build artifacts
+dist/*coverage/*
+
+# data definition files
+**/*.d.ts
+
+# custom definition files
+/src/types/
+
+!.eslintrc.js

samples/webApi/expressjs-with-esdb/.eslintrc.json

@@ -0,0 +1,33 @@
+{
+  "env": {
+    "es2023": true,
+    "node": true
+  },
+  "plugins": ["@typescript-eslint"],
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:@typescript-eslint/recommended-requiring-type-checking",
+    "plugin:prettier/recommended"
+  ],
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "ecmaVersion": 2023,
+    "sourceType": "module",
+    "project": "./tsconfig.json"
+  },
+  "rules": {
+    "no-unused-vars": "off",
+    "@typescript-eslint/no-unused-vars": [
+      "error",
+      { "varsIgnorePattern": "^_", "argsIgnorePattern": "^_" }
+    ],
+    "@typescript-eslint/no-misused-promises": ["off"],
+    "@typescript-eslint/prefer-namespace-keyword": "off"
+  },
+  "settings": {
+    "import/resolver": {
+      "typescript": {}
+    }
+  }
+}

samples/webApi/expressjs-with-esdb/.nvmrc

@@ -0,0 +1 @@
+v20.11.1

samples/webApi/expressjs-with-esdb/.prettierignore

@@ -0,0 +1,2 @@
+**/dist/
+**/lib/

samples/webApi/expressjs-with-esdb/.prettierrc.json

@@ -0,0 +1,4 @@
+{
+  "tabWidth": 2,
+  "singleQuote": true
+}

samples/webApi/expressjs-with-esdb/.vscode/launch.json

@@ -0,0 +1,58 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Debug current file",
+      "type": "node",
+      "request": "launch",
+
+      // Debug current file in VSCode
+      "program": "${file}",
+
+      /*
+    Path to tsx binary
+    Assuming locally installed
+    */
+      "runtimeExecutable": "${workspaceFolder}/node_modules/.bin/tsx",
+
+      /*
+    Open terminal when debugging starts (Optional)
+    Useful to see console.logs
+    */
+      "console": "integratedTerminal",
+      "internalConsoleOptions": "neverOpen",
+
+      // Files to exclude from debugger (e.g. call stack)
+      "skipFiles": [
+        // Node.js internal core modules
+        "<node_internals>/**",
+
+        // Ignore all dependencies (optional)
+        "${workspaceFolder}/node_modules/**"
+      ]
+    },
+    {
+      "name": "Debug All Tests (Node)",
+      "type": "node",
+      "request": "launch",
+      "skipFiles": ["<node_internals>/**"],
+      "runtimeExecutable": "npm",
+      "runtimeArgs": [
+        "run-script",
+        "test",
+        "--inspect-brk=9229",
+        "--preserve-symlinks"
+      ], // Use --inspect-brk for debugging
+      "console": "integratedTerminal",
+      "internalConsoleOptions": "neverOpen",
+      "cwd": "${workspaceFolder}",
+      "sourceMaps": true,
+      "smartStep": true,
+      "resolveSourceMapLocations": [
+        "${workspaceFolder}/**",
+        "!**/node_modules/**",
+        "node_modules/@event-driven.io/emmett-expressjs/**/*.*"
+      ]
+    }
+  ]
+}

samples/webApi/expressjs-with-esdb/.vscode/settings.json

@@ -0,0 +1,24 @@
+{
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "editor.formatOnPaste": false,
+  "editor.formatOnSave": true,
+
+  "editor.codeActionsOnSave": {
+    "source.organizeImports": "explicit",
+    "source.fixAll.eslint": "explicit",
+    "source.addMissingImports": "always"
+  },
+
+  "editor.tabSize": 2,
+
+  "files.exclude": {
+    "**/*.tsbuildinfo": true
+  },
+  "files.eol": "\n",
+
+  "typescript.preferences.importModuleSpecifier": "relative",
+  "eslint.workingDirectories": [{ "mode": "auto" }],
+  "debug.javascript.terminalOptions": {
+    "nodeVersionHint": 20
+  }
+}

samples/webApi/expressjs-with-esdb/.vscode/tasks.json

@@ -0,0 +1,13 @@
+{
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "type": "npm",
+      "script": "build:ts:watch",
+      "group": "build",
+      "problemMatcher": [],
+      "label": "npm: build:ts:watch",
+      "detail": "tsc  --watch"
+    }
+  ]
+}

samples/webApi/expressjs-with-esdb/docker-compose.yml

@@ -0,0 +1,39 @@
+version: '3'
+
+services:
+  #######################################################
+  #  EventStoreDB
+  #######################################################
+  eventstoredb:
+    image: eventstore/eventstore:23.10.0-bookworm-slim
+    # use this image if you're running ARM-based proc like Apple M1
+    # image: eventstore/eventstore:23.10.0-alpha-arm64v8
+    environment:
+      - EVENTSTORE_CLUSTER_SIZE=1
+      - EVENTSTORE_RUN_PROJECTIONS=All
+      - EVENTSTORE_START_STANDARD_PROJECTIONS=true
+      - EVENTSTORE_EXT_TCP_PORT=1113
+      - EVENTSTORE_HTTP_PORT=2113
+      - EVENTSTORE_INSECURE=true
+      - EVENTSTORE_ENABLE_EXTERNAL_TCP=true
+      - EVENTSTORE_ENABLE_ATOM_PUB_OVER_HTTP=true
+    ports:
+      - '1113:1113'
+      - '2113:2113'
+    volumes:
+      - type: volume
+        source: eventstore-volume-data
+        target: /var/lib/eventstore
+      - type: volume
+        source: eventstore-volume-logs
+        target: /var/log/eventstore
+    networks:
+      - esdb_network
+
+networks:
+  esdb_network:
+    driver: bridge
+
+volumes:
+  eventstore-volume-data:
+  eventstore-volume-logs: