project setup

flolu · flolu · commit 77eafe2783a8 · 2021-10-12T11:03:01.000+02:00
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
@@ -0,0 +1 @@
+github: [flolu]
diff --git a/.github/debugging.png b/.github/debugging.png
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -0,0 +1,11 @@
+name: test
+on: [push, pull_request]
+jobs:
+  integration-tests:
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Dummy test
+        run: echo "Dummy test"
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1 @@
+node_modules
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
@@ -0,0 +1,8 @@
+{
+  "recommendations": [
+    "ms-azuretools.vscode-docker",
+    "dbaeumer.vscode-eslint",
+    "esbenp.prettier-vscode",
+    "streetsidesoftware.code-spell-checker"
+  ]
+}
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -0,0 +1,35 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "type": "node",
+      "request": "attach",
+      "name": "App1",
+      "protocol": "inspector",
+      "address": "0.0.0.0",
+      "port": 9229,
+      "restart": true,
+      "sourceMaps": true,
+      "localRoot": "${workspaceFolder}",
+      "remoteRoot": "/",
+      "sourceMapPathOverrides": {
+        "/*": "${workspaceFolder}/*"
+      }
+    },
+    {
+      "type": "node",
+      "request": "attach",
+      "name": "App2",
+      "protocol": "inspector",
+      "address": "0.0.0.0",
+      "port": 9230,
+      "restart": true,
+      "sourceMaps": true,
+      "localRoot": "${workspaceFolder}",
+      "remoteRoot": "/",
+      "sourceMapPathOverrides": {
+        "/*": "${workspaceFolder}/*"
+      }
+    }
+  ]
+}
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,3 @@
+{
+  "cSpell.words": ["Flaticon", "Freepik", "Parens"]
+}
diff --git a/README.md b/README.md
@@ -0,0 +1,36 @@
+<div align="center">
+  <a href="https://github.com/flolu/auth">
+    <img width="100px" height="auto" src="./.github/debugging.png" />
+  </a>
+  <br>
+  <h1>Docker Typescript Debugging</h1>
+  <p>Example for Debugging Node.js + Typescript Running inside Docker Containers with Hot Reload</p>
+  <!-- <a href="https://youtu.be/XXX">
+    <img width="320px" height="180px" src="https://img.youtube.com/vi/XXX/mqdefault.jpg" style="border-radius: 1rem;" />
+    <p>Watch the YouTube Tutorial</p>
+  </a> -->
+</div>
+
+# Usage
+
+**Recommended OS**: Ubuntu 20.04 LTS
+
+**Requirements**: Yarn, Docker, Docker Compose
+
+**Setup**
+
+- `yarn install`
+
+**Development**
+
+- `make dev` or `yarn dev` (Start development backend services, http://localhost:3000)
+- `Ctrl+F5` (Choose which container to debug)
+
+# Codebase
+
+- [`docker-compose.yml`](docker-compose.yml) backend development environment
+- [`.vscode/launch.json`](.vscode/launch.json) launch configuration for debuggers
+
+# Credits
+
+<div>Icons made by <a href="https://www.freepik.com" title="Freepik">Freepik</a> from <a href="https://www.flaticon.com/" title="Flaticon">www.flaticon.com</a></div>
diff --git a/app1.ts b/app1.ts
@@ -0,0 +1,10 @@
+import {sendResponse} from '@lib1'
+import express from 'express'
+
+const app1 = express()
+
+app1.get('*', (_req, res) => {
+  sendResponse(res, 'app1 test 1 2 3 4')
+})
+
+app1.listen(3000)
diff --git a/app2.ts b/app2.ts
@@ -0,0 +1,10 @@
+import {sendResponse} from '@lib1'
+import express from 'express'
+
+const app2 = express()
+
+app2.get('*', (_req, res) => {
+  sendResponse(res, 'app2')
+})
+
+app2.listen(3000)
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -0,0 +1,29 @@
+version: '3'
+services:
+  app1:
+    image: node:14
+    volumes:
+      - ./node_modules:/node_modules
+      - ./package.json:/package.json
+      - ./nodemon.json:/nodemon.json
+      - ./tsconfig.json:/tsconfig.json
+      - ./app1.ts:/app1.ts
+      - ./lib1.ts:/lib1.ts
+    ports:
+      - 3000:3000
+      - 9229:9229
+    command: yarn nodemon --signal SIGINT --inspect=0.0.0.0:9229 --nolazy app1.ts
+
+  app2:
+    image: node:14
+    volumes:
+      - ./node_modules:/node_modules
+      - ./package.json:/package.json
+      - ./nodemon.json:/nodemon.json
+      - ./tsconfig.json:/tsconfig.json
+      - ./app2.ts:/app2.ts
+      - ./lib1.ts:/lib1.ts
+    ports:
+      - 3001:3000
+      - 9230:9229
+    command: yarn nodemon --signal SIGINT --inspect=0.0.0.0:9229 --nolazy app2.ts
diff --git a/lib1.ts b/lib1.ts
@@ -0,0 +1,7 @@
+import {Response} from 'express'
+
+export function sendResponse(res: Response, appName: string) {
+  const span = `<span style="text-decoration: underline;">${appName}<span/>`
+  const heading = `<h1>This is ${span}</h1>`
+  res.send(heading)
+}
diff --git a/nodemon.json b/nodemon.json
@@ -0,0 +1,8 @@
+{
+  "watch": ["app1.ts", "app2.ts", "lib1.ts"],
+  "ext": "ts",
+  "ignore": [".git", "node_modules/**/node_modules"],
+  "execMap": {
+    "ts": "node --require ts-node/register -r tsconfig-paths/register"
+  }
+}
diff --git a/package.json b/package.json
@@ -0,0 +1,28 @@
+{
+  "private": true,
+  "engines": {
+    "node": ">=14"
+  },
+  "scripts": {
+    "dev": "docker-compose -f docker-compose.yml up --build"
+  },
+  "dependencies": {
+    "express": "^4.17.1"
+  },
+  "devDependencies": {
+    "@types/express": "^4.17.13",
+    "@types/node": "^16.10.3",
+    "nodemon": "^2.0.13",
+    "prettier": "^2.4.1",
+    "ts-node": "^10.3.0",
+    "tsconfig-paths": "^3.11.0",
+    "typescript": "^4.4.3"
+  },
+  "prettier": {
+    "singleQuote": true,
+    "bracketSpacing": false,
+    "semi": false,
+    "arrowParens": "avoid",
+    "printWidth": 100
+  }
+}
diff --git a/tsconfig.json b/tsconfig.json
@@ -0,0 +1,12 @@
+{
+  "compilerOptions": {
+    "target": "es5",
+    "strict": true,
+    "esModuleInterop": true,
+    "composite": true,
+    "baseUrl": ".",
+    "paths": {
+      "@lib1": ["./lib1"]
+    }
+  }
+}
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+{`
	`2`	`+ "cSpell.words": ["Flaticon", "Freepik", "Parens"]`
	`3`	`+}`