Skip to main content

Nest.js

Nest.js is a popular Node.js web application framework that simplifies the development of server-side applications. It provides a robust set of features for building web servers and APIs.

tip

Get started in no time with the Nest.js template.

Deployment

Learn how to deploy an existing Nest.js app using Genezio, a serverless deployment platform that simplifies app management and reduces costs.

Prerequisites​

1. Install genezio​

Use your preferred package manager to install Genezio:

npm install genezio -g

2. Ensure you have a Nest.js App​

If you don't have an Nest.js app, you can create one using the following steps:

Create a Hello World Nest.js App

1. Set up your project

Run the following command to initialize a new Node.js project in an empty directory:

npm i -g @nestjs/cli
nest new project-name

2. Test the Nest.js App

Run the following command to start the Nest.js app:

cd project-name
nest start

Open a web browser and navigate to http://localhost:3000 to see the app running.

Deployment Guide​

1. Create configuration file​

First, you need to create the configuration file in the root directory of your Nest.js app, run the following command:

genezio analyze

2. Deploy your project​

Finally, deploy your project. A browser window will open, and you will be prompted to log in to your Genezio account and authorize the CLI to make the deployment. Run the following command in your terminal:

genezio deploy

This command will analyze your project and create the genezio.yaml file in the root directory of your Nest.js app, with the following content:

# The name of your project, which also influences the subdomain of the project.
name: genezio-project
# Select a region closest to your user base for optimal performance.
region: us-east-1
# Specifies the version of the YAML configuration syntax being used.
yamlVersion: 2
# Configuration specific to the Nest.js project setup.
nestjs:
    # The path where the Nest.js project is located.
    path: .
    # The package manager to be used for this project (npm, yarn, etc.)
    packageManager: npm
    # Custom scripts to be run during deployment, e.g., installing dependencies.
    scripts:
        deploy:
            - npm install

Local Development​

To develop and test your app locally, run:

genezio local

You can specify a custom port by setting the GENEZIO_PORT_NESTJS environment variable using one of these methods:

  • Add GENEZIO_PORT_NESTJS=<port> to your .env file
  • Windows: Run set GENEZIO_PORT_NESTJS=<port> && genezio local
  • macOS/Linux: Run GENEZIO_PORT_NESTJS=<port> genezio local

See your app in Genezio Dashboard​

After deploying your application, you can test it to ensure it's running correctly. To verify that your Nest.js app is working, open a web browser and navigate to the URL provided for your deployed app.

Additionally, you can monitor and manage your app through the Genezio App Dashboard. The dashboard URL, also provided after deployment, allows you to access comprehensive views of your project's status and logs.

You can find this URL in the deployment output under the App Dashboard URL section.

Support ​

We invite you to join our community on Discord for further information and help.

Happy Learning!