chore(example): restructure and update basic example

team-supercharge · Aug 24, 2021 · e310273 · e310273
1 parent f388f1d
commit e310273
Show file tree

Hide file tree

Showing 20 changed files with 54 additions and 34 deletions.
diff --git a/example/package.json b/example/package.json
diff --git a/examples/01-Basic_Connection/README.md b/examples/01-Basic_Connection/README.md
@@ -0,0 +1,20 @@
+# Example for nest-amqp
+
+This is a example NestJS project that is using nest-amqp.
+It is a REST-Interface to interact with an ActiveMQ Broker.
+
+## Step 1: Start docker image to have an AMQP broker
+
+```
+docker-compose up
+```
+
+## Step 2: Start example
+
+```
+npm install
+npm run start
+```
+
+HTTP server is listing under port `4444`.
+You can use the requests in `./http-requests/add-user.http` for testing;
diff --git a/example/docker-compose.yml → ...es/01-Basic_Connection/docker-compose.yml b/example/docker-compose.yml → ...es/01-Basic_Connection/docker-compose.yml
diff --git a/example/http-requests/add-user.http → ...ic_Connection/http-requests/add-user.http b/example/http-requests/add-user.http → ...ic_Connection/http-requests/add-user.http
diff --git a/example/http-requests/http-client.env.json → ...ection/http-requests/http-client.env.json b/example/http-requests/http-client.env.json → ...ection/http-requests/http-client.env.json
diff --git a/example/nest-cli.json → examples/01-Basic_Connection/nest-cli.json b/example/nest-cli.json → examples/01-Basic_Connection/nest-cli.json
diff --git a/examples/01-Basic_Connection/package.json b/examples/01-Basic_Connection/package.json
@@ -0,0 +1,31 @@
+{
+  "name": "nest-amqp-example",
+  "scripts": {
+    "prebuild": "rimraf dist",
+    "build": "nest build",
+    "start": "nest start",
+    "start:dev": "nest start --watch",
+    "start:prod": "node dist/main"
+  },
+  "dependencies": {
+    "@nestjs/common": "^8.0.6",
+    "@nestjs/core": "^8.0.6",
+    "@nestjs/platform-express": "^8.0.6",
+    "@team-supercharge/nest-amqp": "^2.0.0",
+    "class-transformer": "^0.4.0",
+    "class-validator": "^0.13.1",
+    "reflect-metadata": "^0.1.13",
+    "rimraf": "^3.0.2",
+    "rxjs": "^7.3.0"
+  },
+  "devDependencies": {
+    "@nestjs/cli": "^8.1.1",
+    "@nestjs/schematics": "^8.0.2",
+    "@types/express": "^4.17.13",
+    "@types/node": "^16.4.13",
+    "ts-loader": "^9.2.5",
+    "ts-node": "^10.2.0",
+    "tsconfig-paths": "^3.10.1",
+    "typescript": "^4.3.5"
+  }
+}
diff --git a/example/src/app/app.controller.ts → ...asic_Connection/src/app/app.controller.ts b/example/src/app/app.controller.ts → ...asic_Connection/src/app/app.controller.ts
diff --git a/example/src/app/app.module.ts → ...01-Basic_Connection/src/app/app.module.ts b/example/src/app/app.module.ts → ...01-Basic_Connection/src/app/app.module.ts
diff --git a/example/src/main.ts → examples/01-Basic_Connection/src/main.ts b/example/src/main.ts → examples/01-Basic_Connection/src/main.ts
diff --git a/example/src/modules/user/user.controller.ts → ...ction/src/modules/user/user.controller.ts b/example/src/modules/user/user.controller.ts → ...ction/src/modules/user/user.controller.ts
diff --git a/example/src/modules/user/user.dto.ts → ...c_Connection/src/modules/user/user.dto.ts b/example/src/modules/user/user.dto.ts → ...c_Connection/src/modules/user/user.dto.ts
diff --git a/example/src/modules/user/user.listener.ts → ...nection/src/modules/user/user.listener.ts b/example/src/modules/user/user.listener.ts → ...nection/src/modules/user/user.listener.ts
diff --git a/example/src/modules/user/user.module.ts → ...onnection/src/modules/user/user.module.ts b/example/src/modules/user/user.module.ts → ...onnection/src/modules/user/user.module.ts
diff --git a/example/src/modules/user/user.queue.ts → ...Connection/src/modules/user/user.queue.ts b/example/src/modules/user/user.queue.ts → ...Connection/src/modules/user/user.queue.ts
diff --git a/example/tsconfig.build.json → ...s/01-Basic_Connection/tsconfig.build.json b/example/tsconfig.build.json → ...s/01-Basic_Connection/tsconfig.build.json
diff --git a/example/tsconfig.json → examples/01-Basic_Connection/tsconfig.json b/example/tsconfig.json → examples/01-Basic_Connection/tsconfig.json
diff --git a/package.json b/package.json
@@ -28,7 +28,7 @@
     "start:dev": "nest start --watch",
     "start:debug": "nest start --debug --watch",
     "start:prod": "node dist/main",
-    "lint": "eslint \"{src,apps,libs,test,example}/**/*.ts\"",
+    "lint": "eslint \"{src,apps,libs,test,examples}/**/*.ts\"",
     "test": "jest",
     "test:watch": "jest --watch",
     "test:cov": "jest --coverage",

diff --git a/tsconfig.build.json b/tsconfig.build.json
@@ -3,5 +3,5 @@
   "compilerOptions": {
     "sourceMap": true
   },
-  "exclude": ["node_modules", "**/*spec.ts", "example", "src/test", "dist"]
+  "exclude": ["node_modules", "**/*spec.ts", "examples", "src/test", "dist"]
 }
diff --git a/tsconfig.prod.json b/tsconfig.prod.json
@@ -3,5 +3,5 @@
   "compilerOptions": {
     "sourceMap": false
   },
-  "exclude": ["node_modules", "**/*spec.ts", "example", "src/test", "dist"]
+  "exclude": ["node_modules", "**/*spec.ts", "examples", "src/test", "dist"]
 }