Docker containerization in NestJS

Introduction

Docker helps you package your NestJS app with everything it needs to run. This makes it easy to share and run your app anywhere without setup problems.

You want to run your NestJS app on different computers or servers without installing Node.js or dependencies each time.

You need to share your app with teammates or deploy it to the cloud quickly.

You want to keep your app isolated so it doesn't affect or get affected by other software on the same machine.

You want to test your app in the same environment as production to avoid surprises.

You want to automate deployment with consistent environments.

Syntax

NestJS

FROM node:18-alpine
WORKDIR /app
COPY package*.json ./
RUN npm install
COPY . .
RUN npm run build
EXPOSE 3000
CMD ["node", "dist/main.js"]

FROM sets the base image with Node.js installed.

WORKDIR sets the folder inside the container where commands run.

Examples

Basic Dockerfile to containerize a NestJS app using Node 18 Alpine image.

NestJS

FROM node:18-alpine
WORKDIR /app
COPY package*.json ./
RUN npm install
COPY . .
RUN npm run build
EXPOSE 3000
CMD ["node", "dist/main.js"]

Example using Yarn package manager instead of npm.

NestJS

FROM node:18-alpine
WORKDIR /usr/src/app
COPY package.json yarn.lock ./
RUN yarn install --frozen-lockfile
COPY . .
RUN yarn build
EXPOSE 3000
CMD ["node", "dist/main.js"]

Using npm ci for faster, clean installs in CI/CD pipelines.

NestJS

FROM node:18-alpine
WORKDIR /app
COPY package*.json ./
RUN npm ci
COPY . .
RUN npm run build
EXPOSE 3000
CMD ["node", "dist/main.js"]

Sample Program

This Dockerfile creates a container for a NestJS app. It uses a small Node.js image, installs dependencies, builds the app, and runs it on port 3000.

NestJS

FROM node:18-alpine

# Set working directory
WORKDIR /app

# Copy package files and install dependencies
COPY package*.json ./
RUN npm install

# Copy all source files
COPY . .

# Build the NestJS app
RUN npm run build

# Expose port 3000
EXPOSE 3000

# Start the app
CMD ["node", "dist/main.js"]

Important Notes

Remember to add a .dockerignore file to exclude node_modules and other unnecessary files to keep the image small.

Use docker build -t your-app-name . to build the image and docker run -p 3000:3000 your-app-name to run it.

Make sure your NestJS app listens on all network interfaces (0.0.0.0) inside the container, not just localhost.

Summary

Docker packages your NestJS app with everything it needs to run anywhere.

Use a Dockerfile to define how to build and run your app inside a container.

Containers help with easy sharing, deployment, and consistent environments.

Practice

1. What is the main purpose of using Docker with a NestJS application?

easy

A. To replace the need for a database in the app

B. To package the app and its environment so it runs the same everywhere

C. To write the NestJS application code faster

D. To automatically generate API documentation

Solution

1. Step 1: Understand Docker's role

   Docker packages an app with all its dependencies and environment settings.

2. Step 2: Apply to NestJS context

   This means the NestJS app runs consistently on any machine with Docker.

3. Final Answer:

   To package the app and its environment so it runs the same everywhere -> Option B

4. Quick Check:

   Docker ensures consistent app environment [OK]

Hint: Docker ensures app runs same everywhere by packaging environment [OK]

Common Mistakes:

• Thinking Docker speeds up coding
• Confusing Docker with database tools
• Assuming Docker auto-generates docs

2. Which of the following is the correct first line in a Dockerfile for a NestJS app using Node 18?

easy

A. USE node@18

B. RUN node install 18

C. FROM node:18-alpine

D. INSTALL node version 18

Solution

1. Step 1: Identify Dockerfile base image syntax

   The Dockerfile starts with FROM followed by the image name and tag.

2. Step 2: Match Node 18 Alpine image

   Correct syntax is 'FROM node:18-alpine' to use Node 18 on Alpine Linux.

3. Final Answer:

   FROM node:18-alpine -> Option C

4. Quick Check:

   Dockerfile base image starts with FROM [OK]

Hint: Dockerfile base image line always starts with FROM [OK]

Common Mistakes:

• Using RUN or INSTALL instead of FROM
• Incorrect syntax like USE node@18
• Confusing Dockerfile commands with shell commands

3. Given this Dockerfile snippet for a NestJS app:

FROM node:18-alpine
WORKDIR /app
COPY package*.json ./
RUN npm install
COPY . .
CMD ["npm", "run", "start"]

What happens when you build and run this container?

medium

A. The container fails because 'COPY' is used incorrectly

B. The container runs but does not start the app

C. The app runs but without installing dependencies

D. The app installs dependencies and starts with 'npm run start'

Solution

1. Step 1: Analyze Dockerfile commands

   WORKDIR sets folder, COPY copies package files, RUN installs dependencies, COPY copies rest, CMD starts app.

2. Step 2: Understand container behavior

   Dependencies are installed before copying source, then app starts with 'npm run start'.

3. Final Answer:

   The app installs dependencies and starts with 'npm run start' -> Option D

4. Quick Check:

   RUN npm install before CMD start [OK]

Hint: RUN npm install before CMD starts app means dependencies installed [OK]

Common Mistakes:

• Thinking COPY package*.json copies whole app
• Assuming dependencies install after app start
• Confusing CMD with RUN commands

4. You wrote this Dockerfile for your NestJS app:

FROM node:18-alpine
WORKDIR /app
COPY . .
RUN npm install
CMD ["npm", "start"]

But when running the container, the app crashes with 'Cannot find module'. What is the likely problem?

medium

A. You copied all files before running npm install, causing missing dependencies

B. The CMD syntax is incorrect and should be a string, not array

C. You forgot to expose the app port in Dockerfile

D. Node 18-alpine image does not support NestJS apps

Solution

1. Step 1: Check COPY and RUN order

   COPY . . copies all files including node_modules if present, then RUN npm install may overwrite or fail.

2. Step 2: Understand missing module cause

   If dependencies are not installed properly before copying, app modules may be missing causing crash.

3. Final Answer:

   You copied all files before running npm install, causing missing dependencies -> Option A

4. Quick Check:

   Order of COPY and RUN npm install matters [OK]

Hint: Run npm install before copying full source to avoid missing modules [OK]

Common Mistakes:

• Blaming CMD syntax for module errors
• Ignoring port exposure as cause
• Assuming Node 18-alpine is incompatible

5. You want to optimize your NestJS Dockerfile to reduce build time by caching dependencies. Which Dockerfile order is best?

hard

A. COPY package*.json ./ then RUN npm install then COPY . . then CMD start

B. COPY . . then RUN npm install then CMD start

C. RUN npm install then COPY package*.json ./ then COPY . . then CMD start

D. CMD start then COPY package*.json ./ then RUN npm install then COPY . .

Solution

1. Step 1: Understand Docker layer caching

   Docker caches layers; copying package files and installing dependencies first caches npm install step.

2. Step 2: Apply best practice order

   Copy package*.json, run npm install, then copy rest of source to avoid reinstalling dependencies on code changes.

3. Final Answer:

   COPY package*.json ./ then RUN npm install then COPY . . then CMD start -> Option A

4. Quick Check:

   Cache dependencies by copying package files first [OK]

Hint: Copy package files first to cache npm install step [OK]

Common Mistakes:

• Copying all files before npm install wastes cache
• Running npm install before copying package files
• Placing CMD before install steps