Deploying a NestJS App

NestJS is a progressive Node.js framework for building efficient, reliable, and scalable server-side applications. It leverages TypeScript by default, provides a modular architecture, and integrates well with modern tools, making it ideal for building robust APIs and microservices.

This guide explains how to deploy a NestJS application to Klutch.sh, both with and without a Dockerfile. It also covers installation and provides sample code to get started.

Prerequisites

• Node.js and npm installed
• Git and GitHub account
• Klutch.sh account

---

Getting Started: Install NestJS

1. Install the NestJS CLI globally:

   npm install -g @nestjs/cli

2. Create a new NestJS app:

   nest new my-nest-app
   cd my-nest-app

3. Start the development server:

   npm run start:dev

   Your app should be running at http://localhost:3000.

Sample Code (src/main.ts)

import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module';

async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  const port = process.env.PORT || 3000;
  await app.listen(port);
}
bootstrap();

---

Deploying Without a Dockerfile

1. Push your NestJS app to a GitHub repository.
2. Log in to Klutch.sh.
3. Create a new project and give it a name.
4. Create a new app:
   • Select your NestJS GitHub repository and branch
   • Set the port to route traffic (usually 3000 for NestJS)
   • Choose region, compute, number of instances, and add any environment variables
5. Add a start script in your package.json:

   "scripts": {
     "start": "nest start"
   }

6. Click “Create” to deploy. Klutch.sh will build and deploy your app automatically.

---

Deploying With a Dockerfile

1. Add a Dockerfile to your project root. Example:

   # Use official Node.js image
   FROM node:18-alpine
   
   # Set working directory
   WORKDIR /app
   
   # Copy package files and install dependencies
   COPY package*.json ./
   RUN npm install --production
   
   # Copy app source
   COPY . .
   
   # Build NestJS app
   RUN npm run build
   
   # Expose port (match your NestJS app)
   EXPOSE 3000
   
   # Start the app
   CMD ["npm", "run", "start:prod"]

2. Push your code (with Dockerfile) to GitHub.
3. In Klutch.sh, follow the same steps to create a project and app, but select the Dockerfile option when prompted.
4. Set the service details and environment variables as needed.
5. Click “Create” to deploy. Klutch.sh will build your Docker image and deploy your app.

Note: Your NestJS app should always listen on the PORT environment variable as shown above.

---

Resources

• Klutch.sh Documentation
• NestJS Documentation

---

Deploying to Klutch.sh is simple and flexible. Choose the method that best fits your workflow and project requirements.