Skip to content

Help you to deploy Nestjs application on Vercel in SSR mode

Notifications You must be signed in to change notification settings

dongwa/vercel-nest

Repository files navigation

Vercel-nest

Vercel builder for Nestjs

Help you to deploy Nestjs application on Vercel

Usage

1. Add build command to package.json

{
  "scripts": {
    "build": "nest build"
  }
}

1. Configure vercel-nest as builder in vercel.json

Add a vercel.json file to your project root path

{
  "builds": [
    {
      "src": "package.json",
      "use": "vercel-nest"
    }
  ]
}

Support Swagger-ui

{
  "builds": [
    {
      "src": "package.json",
      "use": "vercel-nest",
      "config": {
        // change "docs" to your 'path' of SwaggerModule.setup(path, app, document);
        "swagger": "docs"
      }
    }
  ]
}

How to work

  1. Using the npm run build command to build the project. You need to define the build command in your package.json, for example:
{
  "scripts": {
    "build": "nest build"
  }
}
  1. Using dist/main.js as the entry point of the program, and retrieve all its dependency files to build the Vercel Lambda function, named index.

  2. Define a routes to forward all requests to index.

About

Help you to deploy Nestjs application on Vercel in SSR mode

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published