Deploy Simple Spring Boot Project to Heroku using Git and Heroku CLI

Details
Written by  
Last Updated on 29 October 2021   |   Print  Email


In this Heroku tutorial, you will learn how to deploy a simple Spring Boot application from local computer to Heroku cloud platform. By ‘simple Spring Boot app’, I mean that no database required. So the main purpose of this article is helping you get familiar with Heroku’s deployment process.

You can get a sample Spring Boot project from this article, which is a Java web application based on Spring Boot, demonstrating login with in-memory users.

There are several ways to deploy an app to Heroku. And in this tutorial, I’d like to guide you how to use Git and Heroku CLI to deploy a Spring Boot project on to Heroku platform. The project is using Maven build.

Prerequisites: to follow this tutorial, you must have:

- A Heroku account on Heroku.com (Create free Heroku account)

- Git software installed (Download and install Git)

- Heroku CLI installed (Download and install Heroku CLI)

 

1. Login to Heroku

Open a new command prompt (Windows) or terminal (Mac/Linux), and type heroku login to sign in your Heroku account in Heroku CLI. You will be asked to login in web browser, and then come back to the command prompt:

login Heroku CLI


2. Commit Project to Git

Change the current directory to the project directory. Type git init to create a local Git repository for the project:

Git init local repo

Then type git add . to add the project’s files to the local repo’s index (note that there is a dot at the end).

Next, type the following command to commit the project’s files to the local repo:

git commit -m "commit to deploy"

Now, the project is under version control by Git, with the default branch name is ‘master’:

Git commit project


3. Create a new Heroku app

Next, let’s create a new app named my-spring-app-1 on Heroku by using this command:

heroku create my-spring-app-1

Note that the name of your app must be unique across deployed apps on Heroku, so you will have to change the name if it is already taken.

Heroku create new app

You see, a new app is created and assigned a public URL (to be accessible via web browser) and a Git remote repo URL (to deployed via Git push).


4. Set Git remote reference

If the project comes from your local computer, Heroku will update Git remote reference to the remote URL on Heroku. You can type git remote –v to confirm:

Git check remote refs

In case the project is cloned from GitHub, you need to use this command to update the remote reference:

      heroku git:remote –a my-spring-app-1

Heroku set git remote


5. Deploy the project via Git push

Now, let’s type the following command to deploy the project on to Heroku:

git push heroku master

This Git command will send the project’s files to the remote repository on Heroku for deployment, heroku is the remote name and master is the branch name.

Then you will see Heroku detects a Java project, and runs Maven to build the project on remote server, which may take a while. And you should see BUILD SUCCESS output like this:

Heroku deploy success

Heroku also discovers it is a web application and assigns the process type is web. You can see the slug size if the app is 69.7M and the release version is v3. That means the project has been deployed successfully.


6. Run the deployed app

Type the following command to set on dynos running for the deployed web application:

heroku ps:scale web=1 –a my-spring-app-1

Then type heroku open to access the home page of the web application in browser. You should see something like this:

open deployed app

And to view the logs of the app, type heroku logs –a my-spring-app-1.

Congratulations, you have learned how to deploy your first Spring Boot application on to Heroku cloud platform. To see the steps in action, I recommend you watch this video:

 

Other Heroku tutorials:


About the Author:

is certified Java programmer (SCJP and SCWCD). He began programming with Java back in the days of Java 1.4 and has been passionate about it ever since. You can connect with him on Facebook and watch his Java videos on YouTube.