Deploy A NestJS API To Heroku

As I wrote in the previous post, there is still some work involved to get my Nest api deployed.

In this post I'm going to put in that work.

The code in this post continues where the code from the previous post stopped.

I'll deploy my api to Heroku. The main reason for Heroku is that it is free. And I might use their free PostgreSQL addon in the future too.

I'm going to start with using the correct port. For local development port 3000 (or anything else) was ok. But when I deploy to Heroku, they want to be in charge of the port. I can just get it from the PORT env variable.

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

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

RxJS is the next thing I will install. RxJS is being used behind the screens by Nest but somehow I got away without it when I ran my local build. I can't go on without it with my production deploy though.

Then I add a dev dependency on rimraf, this package is rm -rf for node and all I need it for is cleaning up the dist folder before each build.

I'll add some scripts in my package.json to use my newly installed packages.

npm install --save rxjs
npm install --save-dev rimraf
"scripts": {
    "build": "npm run clean && nest build",    "clean": "rimraf dist",    "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
    "start": "nest start --watch",
    "start:prod": "node dist/main"  }

Because I want to use npm run start:prod instead of npm start as the script to start the api I need to specify this in the Heroku specific Procfile.

web: npm run start:prod

That is all I need to do in my code. Now I need to configure Heroku. Time for some screenshots.

After logging in I create a new app and give it a very descriptive name.

New App

Create New App

Connecting to GitHub is easy. In the next block I can search for my repo and connect it.

Connect To GitHub

Finally I need to enable automatic deploys so each push will trigger a deploy.

Automatic Deploys

I commit all my changes and push.

git add .
git commit -m "auto deploy go!"
git push

In the activity tab I can see the build is in progress.

Build In Progress

When the build is finished I can browse to https://deploy-nestjs-api-to-heroku.herokuapp.com/hello/world and see a production deploy of my api in action!

That was even easier than I expected.

What should I tackle next, testing or user authentication?