feat: add devcontainer configuration

.devcontainer/devcontainer.json

@@ -0,0 +1,51 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/docker-existing-docker-compose
+{
+  "name": "Existing Docker Compose (Extend)",
+  // Update the 'dockerComposeFile' list if you have more compose files or use different names.
+  // The .devcontainer/docker-compose.yml file contains any overrides you need/want to make.
+  "dockerComposeFile": [
+    "../docker-compose.yml",
+    "docker-compose.yml"
+  ],
+  // The 'service' property is the name of the service for the container that VS Code should
+  // use. Update this value and .devcontainer/docker-compose.yml to the real service name.
+  "service": "app",
+  // The optional 'workspaceFolder' property is the path VS Code should open by default when
+  // connected. This is typically a file mount in .devcontainer/docker-compose.yml
+  "workspaceFolder": "/usr/src/app",
+  "postCreateCommand": "npm install",
+  "customizations": {
+    "vscode": {
+      "extensions": [
+        "esbenp.prettier-vscode",
+        "editorconfig.editorconfig",
+        "dbaeumer.vscode-eslint",
+        "wayou.vscode-todo-highlight",
+        "mike-co.import-sorter",
+        "waderyan.gitblame",
+        "ms-vscode.vscode-typescript-tslint-plugin",
+        "ms-azuretools.vscode-docker",
+        "firsttris.vscode-jest-runner"
+      ]
+    }
+  },
+  "mounts": [
+    "source=${localWorkspaceFolder},target=/usr/src/app,type=bind",
+    "source=node_modules,target=/usr/src/app/node_modules,type=volume"
+  ]
+  // Features to add to the dev container. More info: https://containers.dev/features.
+  // "features": {},
+  // Use 'forwardPorts' to make a list of ports inside the container available locally.
+  // "forwardPorts": [],
+  // Uncomment the next line if you want start specific services in your Docker Compose config.
+  // "runServices": [],
+  // Uncomment the next line if you want to keep your containers running after VS Code shuts down.
+  // "shutdownAction": "none",
+  // Uncomment the next line to run commands after the container is created.
+  // "postCreateCommand": "cat /etc/os-release",
+  // Configure tool-specific properties.
+  // "customizations": {},
+  // Uncomment to connect as an existing user other than the container default. More info: https://aka.ms/dev-containers-non-root.
+  // "remoteUser": "vscode"
+}

.devcontainer/docker-compose.yml

@@ -0,0 +1,29 @@
+version: '3.8'
+services:
+  # Update this to the name of the service you want to work with in your docker-compose.yml file
+  app:
+    # Uncomment if you want to override the service's Dockerfile to one in the .devcontainer
+    # folder. Note that the path of the Dockerfile and context is relative to the *primary*
+    # docker-compose.yml file (the first in the devcontainer.json "dockerComposeFile"
+    # array). The sample below assumes your primary file is in the root of your project.
+    #
+    # build:
+    #   context: .
+    #   dockerfile: .devcontainer/Dockerfile
+
+    volumes:
+      # Update this to wherever you want VS Code to mount the folder of your project
+      - ..:/usr/src/app:cached
+      - node_modules:/usr/src/app/node_modules
+
+    # Uncomment the next four lines if you will use a ptrace-based debugger like C++, Go, and Rust.
+    # cap_add:
+    #   - SYS_PTRACE
+    # security_opt:
+    #   - seccomp:unconfined
+
+    # Overrides default command so things don't shut down after the process ends.
+    command: /bin/sh -c "while sleep 1000; do :; done"
+
+volumes:
+  node_modules:

.github/dependabot.yml

@@ -1,5 +1,8 @@
-# Basic dependabot.yml file with
-# minimum configuration for two package managers
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for more information:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+# https://containers.dev/guide/dependabot
 
 version: 2
 updates:
@@ -9,7 +12,7 @@ updates:
     directory: '/'
     # Check the npm registry for updates every day (weekdays)
     schedule:
-      interval: 'daily'
+      interval: 'weekly'
 
   # Enable version updates for Docker
   - package-ecosystem: 'docker'
@@ -18,3 +21,9 @@ updates:
     # Check for updates once a week
     schedule:
       interval: 'weekly'
+
+  # Enable version updates for devcontainers
+  - package-ecosystem: 'devcontainers'
+    directory: '/'
+    schedule:
+      interval: 'weekly'

.github/workflows/build-workflow.yml

@@ -1,18 +1,28 @@
 name: build
 
 on:
+  push:
+    branches:
+      - master
   pull_request:
-    branches: [master]
+    types: [opened, synchronize, reopened]
 
 jobs:
-  build_pull_request:
+  run_build:
     runs-on: ubuntu-latest
 
     steps:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
-          node-version: 16
+          node-version: 20.14.0
+      - name: Cache node modules
+        uses: actions/cache@v3
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-
       - run: npm ci
       - name: Run build step
         run: npm run build

.github/workflows/sonarqube-workflow.yml

@@ -1,10 +1,13 @@
 name: SonarCloud build
-on:
-  push:
-    branches:
-      - master
-  pull_request:
-    types: [opened, synchronize, reopened]
+
+# Uncomment once you set up Sonarqube
+# on:
+#   push:
+#     branches:
+#       - master
+#   pull_request:
+#     types: [opened, synchronize, reopened]
+
 jobs:
   sonarcloud:
     name: SonarCloud
@@ -15,7 +18,14 @@ jobs:
           fetch-depth: 0 # Shallow clones should be disabled for a better relevancy of analysis
       - uses: actions/setup-node@v3
         with:
-          node-version: 16
+          node-version: 20.14.0
+      - name: Cache node modules
+        uses: actions/cache@v3
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-
       - run: npm ci
       - name: Run test cov
         run: npm run test:cov

.github/workflows/tests-workflow.yml

@@ -1,8 +1,11 @@
 name: tests
 
 on:
+  push:
+    branches:
+      - master
   pull_request:
-    branches: [master]
+    types: [opened, synchronize, reopened]
 
 jobs:
   test_pull_request:
@@ -25,7 +28,14 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
-          node-version: 16
+          node-version: 20.14.0
+      - name: Cache node modules
+        uses: actions/cache@v3
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-
       - run: npm ci
       - name: Run unit tests
         run: npm test

.gitignore

@@ -392,3 +392,4 @@ dist
 local/
 documentation
 test-report.xml
+tsconfig.build.tsbuildinfo

.tool-versions

@@ -0,0 +1 @@
+nodejs 20.14.0

.vscode/extensions.json

@@ -1,6 +1,7 @@
 {
   "recommendations": [
     "esbenp.prettier-vscode",
-    "ms-vscode.vscode-typescript-tslint-plugin"
+    "ms-vscode.vscode-typescript-tslint-plugin",
+    "firsttris.vscode-jest-runner"
   ]
 }

.vscode/settings.json

@@ -1,6 +1,6 @@
 {
   "editor.codeActionsOnSave": {
-    "source.fixAll.tslint": true
+    "source.fixAll.tslint": "explicit"
   },
   "editor.insertSpaces": true,
   "editor.tabSize": 2,
@@ -19,5 +19,6 @@
   },
   "[typescriptreact]": {
     "editor.defaultFormatter": "esbenp.prettier-vscode"
-  }
+  },
+  "typescript.preferences.importModuleSpecifier": "relative",
 }

Dockerfile

@@ -1,32 +1,30 @@
-# lts-gallium refers to v16
-# Using this instead of node:16 to avoid dependabot updates
-FROM node:lts-gallium as builder
+# Development Dockerfile
+FROM node:20.14.0-bookworm-slim
+
+# Install additional tools for development
+RUN apt-get update && apt-get install -y \
+  vim \
+  curl \
+  wget \
+  git \
+  && apt-get clean \
+  && rm -rf /var/lib/apt/lists/*
 
 WORKDIR /usr/src/app
 
+# Copy and install dependencies
 COPY package.json package-lock.json ./
-RUN npm ci
+RUN npm install
 
+# Copy the rest of the application files
 COPY . .
 
+# Set the environment variables
 ARG APP_ENV=development
 ENV NODE_ENV=${APP_ENV}
 
-RUN npm run build
-
-RUN npm prune
-
-FROM node:lts-gallium
-
-ARG APP_ENV=development
-ENV NODE_ENV=${APP_ENV}
-
-WORKDIR /usr/src/app
-COPY --from=builder /usr/src/app/node_modules ./node_modules
-COPY --from=builder /usr/src/app/package*.json ./
-COPY --from=builder /usr/src/app/dist ./dist
-
+# Expose the application port
 EXPOSE 3000
 
-USER node
-CMD [ "npm", "run", "start:prod" ]
+# Set the default command to run the application with nodemon
+CMD ["npm", "start:dev"]

Dockerfile.prod

@@ -0,0 +1,42 @@
+# Stage 1: Build the application
+FROM node:20.14.0-bookworm-slim as builder
+
+WORKDIR /usr/src/app
+
+# Install dependencies
+COPY package.json package-lock.json ./
+RUN npm ci
+
+# Copy the rest of the application files
+COPY . .
+
+# Build the application
+ARG APP_ENV=production
+ENV NODE_ENV=${APP_ENV}
+RUN npm run build
+
+# Prune development dependencies
+RUN npm prune --production
+
+# Stage 2: Create the production image
+FROM node:20.14.0-bookworm-slim
+
+WORKDIR /usr/src/app
+
+# Copy only the necessary files from the builder stage
+COPY --from=builder /usr/src/app/node_modules ./node_modules
+COPY --from=builder /usr/src/app/package*.json ./
+COPY --from=builder /usr/src/app/dist ./dist
+
+# Set the environment variables
+ARG APP_ENV=production
+ENV NODE_ENV=${APP_ENV}
+
+# Expose the application port
+EXPOSE 3000
+
+# Use a non-root user for security
+USER node
+
+# Set the default command to run the application
+CMD [ "npm", "run", "start:prod" ]

README.md

@@ -3,13 +3,10 @@
 [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
 ![Build Badge](https://github.com/monstar-lab-oss/nestjs-starter-rest-api/workflows/build/badge.svg)
 ![Tests Badge](https://github.com/monstar-lab-oss/nestjs-starter-rest-api/workflows/tests/badge.svg)
-[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=monstar-lab-oss_nestjs-starter-rest-api&metric=alert_status)](https://sonarcloud.io/dashboard?id=monstar-lab-oss_nestjs-starter-rest-api)
-[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=monstar-lab-oss_nestjs-starter-rest-api&metric=coverage)](https://sonarcloud.io/dashboard?id=monstar-lab-oss_nestjs-starter-rest-api)
-[![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=monstar-lab-oss_nestjs-starter-rest-api&metric=code_smells)](https://sonarcloud.io/dashboard?id=monstar-lab-oss_nestjs-starter-rest-api)
 
 This starter kit has the following outline:
 
-- Monolithic Project.
+- Monolithic Project
 - REST API
 
 This is a Github Template Repository, so it can be easily [used as a starter template](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template) for other repositories.
@@ -32,6 +29,7 @@ One of our main principals has been to keep the starter kit as lightweight as po
 | Request Validation       | class-validator    | Done     |
 | Pagination               | SQL offset & limit | Done     |
 | Docker Ready             | Dockerfile         | Done     |
+| Devcontainer             | -                  | Done     |
 | Auto-generated OpenAPI   | -                  | Done     |
 | Auto-generated ChangeLog | -                  | WIP      |
 

docker-compose.yml

@@ -10,8 +10,8 @@ services:
     ports:
       - 3000:3000
     volumes:
-      - ./:/usr/src/app
-      - node_modules:/usr/src/app/node_modules/
+      - ./:/usr/src/app:cached
+      - node_modules:/usr/src/app/node_modules
     environment:
       APP_ENV: ${APP_ENV}
       APP_PORT: ${APP_PORT}
@@ -29,7 +29,7 @@ services:
       - pgsqldb
 
   pgsqldb:
-    image: postgres:14.3
+    image: postgres:16.3
     environment:
       POSTGRES_USER: "${DB_USER}"
       POSTGRES_PASSWORD: "${DB_PASS}"

ormconfig.ts

@@ -6,7 +6,7 @@ dotenv.config();
 const typeOrmConfig = new DataSource({
   type: 'postgres',
   host: process.env.DB_HOST,
-  port: process.env.DB_PORT ? parseInt(process.env.DB_PORT, 10) : null,
+  port: process.env.DB_PORT ? parseInt(process.env.DB_PORT, 10) : undefined,
   database: process.env.DB_NAME,
   username: process.env.DB_USER,
   password: process.env.DB_PASS,

src/article/controllers/article.controller.spec.ts

@@ -85,7 +85,7 @@ describe('ArticleController', () => {
 
       try {
         await controller.createArticle(ctx, input);
-      } catch (error) {
+      } catch (error: any) {
         expect(error.message).toEqual('rejected');
       }
     });