fixing dockerized bug, and adding auto documentation with openapi

Author: daniwebdev

.env.example

@@ -1,3 +1,5 @@
+PROJECT_NAME=starter-kit # please use kebab-case or snake_case, example : starter-kit or starter_kit
+
 APP_ENV=development
 APP_API_KEY=sandbox
 
@@ -28,6 +30,8 @@ GOOGLE_APPLICATION_CREDENTIALS=/app/dist/service-account.json
 
 
 # DOCKER ENV
-DB_EXPOSED_PORT=
-APP_EXPOSED_PORT=
-REDIS_EXPOSED_PORT=
+DB_EXPOSED_PORT=8610
+APP_EXPOSED_PORT=8611
+ADMINER_EXPOSED_PORT=8613
+REDIS_EXPOSED_PORT=8612
+SMTP_EXPOSED_PORT=8614

Dockerfile

@@ -21,7 +21,8 @@ WORKDIR /app
 RUN --mount=type=bind,source=package.json,target=package.json \
     --mount=type=bind,source=yarn.lock,target=yarn.lock \
     --mount=type=cache,target=/root/.yarn \
-    yarn install --production --frozen-lockfile
+    yarn install
+    # yarn install --production --frozen-lockfile
 
 # Run the application as a non-root user.
 USER node
@@ -33,5 +34,4 @@ COPY . .
 EXPOSE 8100
 
 # Run the application.
-CMD yarn run build
-CMD yarn run start:dev
+CMD yarn run start:dev

compose.yaml

@@ -7,14 +7,15 @@
 # You can add other services your application may depend on here, such as a
 # database or a cache. For examples, see the Awesome Compose repository:
 # https://github.com/docker/awesome-compose
-name: "starter-kit"
+name: ${PROJECT_NAME}
 services:
   app:
     container_name: "starter-kit-app"
     build:
       context: .
     environment:
-      NODE_ENV: production
+      # NODE_ENV: production # will installed without 'devDependencies'
+      NODE_ENV: development
     ports:
       - ${APP_EXPOSED_PORT:-8610}:3000
     depends_on:
@@ -29,6 +30,7 @@ services:
       - /bin/sh
       - -c
       - |
+        yarn install
         yarn run build
         yarn run start:dev
 

package.json

@@ -4,7 +4,7 @@
   "description": "",
   "author": "",
   "private": true,
-  "license": "UNLICENSED",
+  "license": "MIT",
   "scripts": {
     "build": "nest build",
     "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
@@ -31,6 +31,7 @@
     "@nestjs/jwt": "^10.1.0",
     "@nestjs/passport": "^10.0.2",
     "@nestjs/platform-express": "^10.0.2",
+    "@nestjs/swagger": "^7.1.13",
     "@nestjs/typeorm": "^10.0.0",
     "@svtslv/nestjs-ioredis": "^1.0.2",
     "bcrypt": "^5.1.0",
@@ -50,7 +51,7 @@
     "uuid": "^9.0.0"
   },
   "devDependencies": {
-    "@nestjs/cli": "^10.1.0",
+    "@nestjs/cli": "^10.1.18",
     "@nestjs/schematics": "^10.0.2",
     "@nestjs/testing": "^10.2.7",
     "@types/bcrypt": "^5.0.0",

src/apps/auth/auth.controller.ts

@@ -6,6 +6,7 @@ import { AuthService } from './auth.service';
 import { LoginDTO } from './dto/login.dto';
 import { RegisterDTO } from './dto/register.dto';
 import { I18n, I18nContext } from 'nestjs-i18n';
+import { ApiTags } from '@nestjs/swagger';
 
 @Controller('auth')
 export class AuthController {
@@ -14,6 +15,7 @@ export class AuthController {
         private authService: AuthService,
     ) {}
 
+    @ApiTags("Auth")
     @Post('/login')
     @HttpCode(HttpStatus.OK)
     async login(

src/main.ts

@@ -4,6 +4,7 @@ import { join } from 'path';
 import { ApiKeyGuard } from './apps/app.guard';
 import { AppModule } from './apps/app.module';
 import { HttpExceptionFilter } from './common/filters/http-exception.filter';
+import { SwaggerModule, DocumentBuilder } from '@nestjs/swagger';
 
 const APP_PORT = 3000;
 
@@ -20,9 +21,31 @@ async function bootstrap() {
 
   app.setViewEngine('ejs');
 
-  await app.listen(APP_PORT);
 
-  console.log('listening http://0.0.0.0:' + APP_PORT);
+
+  const config = new DocumentBuilder()
+    .setTitle('StarterKit Project')
+    .setDescription('This is nestjs starter kit, it\'s will help you when creating new project with nestjs.')
+    .setVersion('1.0')
+    .addTag('Auth', "All about authentication")
+    .build();
+  const document = SwaggerModule.createDocument(app, config);
+  SwaggerModule.setup('api', app, document);
+
+  await app.listen(APP_PORT);
+  
+  console.log("--------------------------------------------------------");
+  
+  if(process.env.DB_EXPOSED_PORT != undefined) {
+    console.log(`Adminer Exposed on http://0.0.0.0:${process.env.ADMINER_EXPOSED_PORT}/?pgsql=${process.env.DB_HOST}&username=${process.env.DB_USER}&db=${process.env.DB_NAME}`);
+  }
+  
+  if(process.env.APP_EXPOSED_PORT != undefined) {
+    console.log(`App Exposed on http://0.0.0.0:${process.env.APP_EXPOSED_PORT}`);
+  }
+
+  console.log("--------------------------------------------------------");
+  
 }
 
 bootstrap();

yarn.lock

@@ -816,7 +816,7 @@
   resolved "https://registry.yarnpkg.com/@nestjs/cache-manager/-/cache-manager-2.1.0.tgz#e4dadc4ba9c02c059db4dac5e0b5513466e2895a"
   integrity sha512-9kep3a8Mq5cMuXN/anGhSYc0P48CRBXk5wyJJRBFxhNkCH8AIzZF4CASGVDIEMmm3OjVcEUHojjyJwCODS17Qw==
 
-"@nestjs/cli@^10.1.0":
+"@nestjs/cli@^10.1.18":
   version "10.1.18"
   resolved "https://registry.yarnpkg.com/@nestjs/cli/-/cli-10.1.18.tgz#7aa0099eea5fe60787eb822f9a8a6d47e22d0123"
   integrity sha512-jQtG47keLsACt7b4YwJbTBYRm90n82gJpMaiR1HGAyQ9pccbctjSYu592eT4bxqkUWxPgBE3mpNynXj7dWAfrw==
@@ -883,6 +883,11 @@
     "@types/jsonwebtoken" "9.0.2"
     jsonwebtoken "9.0.0"
 
+"@nestjs/[email protected]":
+  version "2.0.2"
+  resolved "https://registry.yarnpkg.com/@nestjs/mapped-types/-/mapped-types-2.0.2.tgz#c8a090a8d22145b85ed977414c158534210f2e4f"
+  integrity sha512-V0izw6tWs6fTp9+KiiPUbGHWALy563Frn8X6Bm87ANLRuE46iuBMD5acKBDP5lKL/75QFvrzSJT7HkCbB0jTpg==
+
 "@nestjs/passport@^10.0.2":
   version "10.0.2"
   resolved "https://registry.yarnpkg.com/@nestjs/passport/-/passport-10.0.2.tgz#42ad193bccec3c332ac8b5e04cf6897bd57500fb"
@@ -921,6 +926,17 @@
     jsonc-parser "3.2.0"
     pluralize "8.0.0"
 
+"@nestjs/swagger@^7.1.13":
+  version "7.1.13"
+  resolved "https://registry.yarnpkg.com/@nestjs/swagger/-/swagger-7.1.13.tgz#5fe1127b159780315f6e827d746b68db7f323e38"
+  integrity sha512-aHfW0rDZZKTuPVSkxutBCB16lBy5vrsHVoRF5RvPtH7U2cm4Vf+OnfhxKKuG2g2Xocn9sDL+JAyVlY2VN3ytTw==
+  dependencies:
+    "@nestjs/mapped-types" "2.0.2"
+    js-yaml "4.1.0"
+    lodash "4.17.21"
+    path-to-regexp "3.2.0"
+    swagger-ui-dist "5.9.0"
+
 "@nestjs/testing@^10.2.7":
   version "10.2.7"
   resolved "https://registry.yarnpkg.com/@nestjs/testing/-/testing-10.2.7.tgz#50408ccb4c809d216a12d60ac7932fd6ad7fedf4"
@@ -4579,6 +4595,13 @@ js-tokens@^4.0.0:
   resolved "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz"
   integrity sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==
 
+[email protected], js-yaml@^4.1.0:
+  version "4.1.0"
+  resolved "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.0.tgz"
+  integrity sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==
+  dependencies:
+    argparse "^2.0.1"
+
 js-yaml@^3.13.1:
   version "3.14.1"
   resolved "https://registry.npmjs.org/js-yaml/-/js-yaml-3.14.1.tgz"
@@ -4587,13 +4610,6 @@ js-yaml@^3.13.1:
     argparse "^1.0.7"
     esprima "^4.0.0"
 
-js-yaml@^4.1.0:
-  version "4.1.0"
-  resolved "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.0.tgz"
-  integrity sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==
-  dependencies:
-    argparse "^2.0.1"
-
 jsesc@^2.5.1:
   version "2.5.2"
   resolved "https://registry.npmjs.org/jsesc/-/jsesc-2.5.2.tgz"
@@ -7016,6 +7032,11 @@ supports-preserve-symlinks-flag@^1.0.0:
   resolved "https://registry.npmjs.org/supports-preserve-symlinks-flag/-/supports-preserve-symlinks-flag-1.0.0.tgz"
   integrity sha512-ot0WnXS9fgdkgIcePe6RHNk1WA8+muPa6cSjeR3V8K27q9BB1rTE3R1p7Hv0z1ZyAc8s6Vvv8DIyWf681MAt0w==
 
+[email protected]:
+  version "5.9.0"
+  resolved "https://registry.yarnpkg.com/swagger-ui-dist/-/swagger-ui-dist-5.9.0.tgz#d52b6cf52fd0a8e6930866c402aaa793fe4e3f76"
+  integrity sha512-NUHSYoe5XRTk/Are8jPJ6phzBh3l9l33nEyXosM17QInoV95/jng8+PuSGtbD407QoPf93MH3Bkh773OgesJpA==
+
 [email protected]:
   version "4.0.0"
   resolved "https://registry.npmjs.org/symbol-observable/-/symbol-observable-4.0.0.tgz"