Deploying a Strapi API on Heroku in 5 min

Our community is looking for talented writers who are passionate about our ecosystem (jamstack, open-source, javascript) and willing to share their knowledge/experiences through our Write for the community program.

As a programmer developing a Strapi API, you will have, sooner or later, to deploy your app online. To do so, many options are available.

The default one is to use a Linux instance on a IaaS (Infrastructure as a Service) provider such as AWS or DigitalOcean, Azure, Google App Engine or render and configure it for your app. However, this option is complex and may involve some critical security issues if you are not familiar with DevOps.

In order to make hosting easier, a new kind of solution emerged in the last few years: Platforms as a Service (PaaS). The idea behind this concept is to make hosting way easier and let developers focus on their code instead of their servers infrastructure. The most famous one is definitely Heroku. Heroku relies on AWS and is trusted by thousands of companies.

Many of you wanted to discover how to easily deploy a Strapi app on Heroku. It didn't fall on deaf ears. This tutorial intends to explain you the necessary steps to push in production a clean Strapi app, using Heroku for both hosting and database.

First of all, we are going to configure a Heroku account. Then, we will generate a brand new Strapi API and deploy it. As a bonus, you will also discover the one-click deploy button:

Heroku setup

Heroku is an online service, so, except if you already have an account (go to section "Heroku CLI setup"), you need to create one:

Register

Visit the register page, fill in the form and submit it:

Validate your email address

To complete the registration process, validate your email address by clicking on the link in the email you received from Heroku and choose a password:

That's it, your account is up and running:

Let's go further!

Heroku CLI setup

Heroku offers a powerful CLI to manage your apps through your terminal.

Installation

To install the CLI, follow the instructions corresponding to your operating system:

Ubuntu

sudo snap install --classic heroku

MacOS

brew tap heroku/brew && brew install heroku

Standalone installation

curl https://cli-assets.heroku.com/install.sh | sh

Make sure Homebrew is installed on your computer.

Windows

Download and run the Windows installer 32-bit 64-bit.

Note: if you encounter any issue, take a look at the Heroku CLI documentation.

Login

• In order to link your Heroku account, you need to login:

heroku login

Congrats, you successfully created a Heroku account and configured the Heroku the CLI!

Create a Strpai project

Requirements: please make sure Node 12 is installed on your machine.

• Create a Strapi project by running the following command:

# Using yarn
yarn create strapi-app my-app --quickstart

# Using npx
npx create-strapi-app my-app --quickstart

This Strapi project is using SQLite as development database. However for the production database we are going to use postgres. In fact Heroku provide a free Postgres addon that allows you to use a postgres database for your app.

We'll install pg but also a useful package that will split the DATABASE_URL that the addon will give us.

• Install the pg package and the pg-connection-string package to your Strapi project by running the following command:

cd my-app
yarn add pg pg-connection-string

Now we want to configure the database connection for the production environment.

• Create a ./config/env/production/database.js file containing the following code:

const { parse } = require("pg-connection-string");

module.exports = ({ env }) => {
  const { host, port, database, user, password } = parse(env("DATABASE_URL"));

  return {
    defaultConnection: "default",
    connections: {
      default: {
        connector: "bookshelf",
        settings: {
          client: "postgres",
          host,
          port,
          database,
          username: user,
          password,
          ssl: { rejectUnauthorized: false }
        },
        options: {
          ssl: false
        },
      },
    },
  };
};

Perfect! You project is now ready to be deployed on Heroku. So as you understood, your project will use an SQLite db locally but a postgres database on production now.

Init the git repository

Git is the de-facto solution to version code. Heroku highly relies on it to detect changes. That means everytime you update your codebase, you only need to commit your changes and push them to Heroku.

Our app is not versioned yet, so we are going to init the Git repository, add the files and submit the first commit:

git init
heroku git:remote -a NAME_OF_HEROKU_APP
git add .
git commit -am "Initial commit"

Heroku create

We have never been so closed to the deployment.

• Let's inform Heroku we want to create a new project by running the following command:

heroku create

At this point, you should already be able to see the app in your Heroku dashboard:

Postgres addon

Heroku created the addons system. Addons are integrated tools and services for developing, extending, and operating apps. All kind of addons are available: Monitoring, Email/SMS, Testing, Search, Image Processing, etc. and, obviously, Data Stores. MongoDB is provided in Heroku addons through several services, including Compose, ObjectRocket and mLab.

In this tutorial, we are going to use the Postgres addon, which provides a free Sandbox plan. If you plan to deploy your app in production, we highly recommend you to switch to a paid plan.

Postgres addon exposes an environment variable named DATABASE_URL to your project. Its value is a string looking like this: postgres://YourUserName:YourPassword@YourHostname:5432/YourDatabaseName. As you can see, it contains all the necessary informations to connect to the Postgres instance: username, password, host, port and database name.

• Now that you know a bit more about addons, let's create one by running the following command:

heroku addons:create heroku-postgresql:hobby-dev --app NAME_OF_HEROKU_APP

Deploy to Heroku

Let's make the magic happen!

• Push your code to Heroku:

git push heroku master

This is as simple as that! Click on the link at the bottom of the logs to discover your Strapi app online:

Bonus - Introducing the one-click deploy

Because deployment is never too easy, Heroku introduced the deploy button. This button allows open-source projects owners (and others) to let users deploy apps within one click.

Since it can be a huge benefit for current and future Strapi users to preview what Strapi is, we decided to make it available for you.

From now, you can deploy a Strapi app just by clicking on this button:

After that, to do any update, clone it using the Heroku git URL (heroku info heroku-project-name) and customize it according to your needs.

Conclusion

Congratulations! You successfully deployed a brand new Strapi app on Heroku.

In this tutorial, we have seen various aspects of Heroku concepts. To go deeper and perfectly setup your app for production, we strongly recommend you to read the documentation about topics such as scalability, GitHub based deployments, pipelines, etc.

We hope you enjoyed this tutorial. Please comment it to give your feedback and explain how you usually deploy your Strapi APIs.

Please note: Since we initially published this blog post, we released new versions of Strapi and tutorials may be outdated. Sorry for the inconvenience if it's the case. Please help us by reporting it here.

Get started with Strapi by creating a project, using a starter or trying our instant live demo. Also, join our academy to become a Strapi expert, and consult our forum if you have any questions. We will be there to help you.