The Project | About Us | Contribute | Donations | License
HOME My courses Completed
◄ Previous
◄

Deploying to Heroku

Next ►
►

Deploying a Spring Boot application to Heroku is a straightforward process thanks to Heroku's support for Java applications. In this section, we will cover the steps required to deploy your Spring Boot application to Heroku.

Prerequisites

Before we begin, ensure you have the following:

  • A Heroku account. If you don't have one, you can sign up at Heroku.
  • Heroku CLI installed on your machine. You can download it from Heroku CLI.

Steps to Deploy a Spring Boot Application to Heroku

  1. Create a Spring Boot Application

If you don't already have a Spring Boot application, you can create one using Spring Initializr or your preferred method. For this example, we'll assume you have a simple Spring Boot application ready.

  1. Add a Procfile

Heroku uses a Procfile to determine how to run your application. Create a file named Procfile in the root directory of your project with the following content:

web: java -Dserver.port=$PORT -jar target/your-application-name.jar

Replace your-application-name.jar with the name of your JAR file.

  1. Build Your Application

Build your Spring Boot application using Maven or Gradle. This will generate a JAR file in the target directory.

For Maven:

mvn clean package

For Gradle:

./gradlew build

  1. Initialize a Git Repository

Heroku uses Git for deployment. Initialize a Git repository in your project directory if you haven't already:

git init

Add all your files to the repository and commit them:

git add .
git commit -m "Initial commit"

  1. Create a Heroku Application

Log in to Heroku using the Heroku CLI:

heroku login

Create a new Heroku application:

heroku create

This command will create a new application and provide you with a URL where your application will be hosted.

  1. Deploy Your Application

Push your code to Heroku using Git:

git push heroku master

Heroku will automatically detect your application as a Java application, build it, and deploy it.

  1. Open Your Application

Once the deployment is complete, you can open your application in a web browser:

heroku open

Practical Example

Let's go through a practical example of deploying a simple Spring Boot application to Heroku.

Example Application

Create a simple Spring Boot application with a single REST endpoint.

Application.java

package com.example.demo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@SpringBootApplication
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

@RestController
class HelloController {
    @GetMapping("/")
    public String hello() {
        return "Hello, Heroku!";
    }
}

Steps to Deploy

  1. Create a Procfile:

    web: java -Dserver.port=$PORT -jar target/demo-0.0.1-SNAPSHOT.jar

  2. Build the application:

    mvn clean package

  3. Initialize a Git repository:

    git init
git add .
git commit -m "Initial commit"

  4. Create a Heroku application:

    heroku create

  5. Deploy the application:

    git push heroku master

  6. Open the application:

    heroku open

Common Mistakes and Tips

  • Missing Procfile: Ensure you have a Procfile in the root directory of your project. Without it, Heroku won't know how to run your application.
  • Port Configuration: Heroku assigns a dynamic port to your application. Make sure your application is configured to use the port provided by Heroku ($PORT).
  • Dependencies: Ensure all necessary dependencies are included in your pom.xml or build.gradle file.

Conclusion

Deploying a Spring Boot application to Heroku is a simple and efficient way to get your application online. By following the steps outlined in this section, you can quickly deploy your application and make it accessible to users. In the next section, we will cover deploying Spring Boot applications to AWS.

◄ Previous
◄
Next ►
►

Spring Boot Course

Module 1: Introduction to Spring Boot

Module 2: Spring Boot Basics

Module 3: Building RESTful Web Services

Module 4: Data Access with Spring Boot

Module 5: Spring Boot Security

Module 6: Testing in Spring Boot

Module 7: Advanced Spring Boot Features

Module 8: Deploying Spring Boot Applications

Module 9: Performance and Monitoring

Module 10: Best Practices and Tips

The Project | About Us | Contribute | Donations | License
© Copyright 2024. All rights reserved