Deploy a Spring Boot App for Free on Railway (No Credit Card)

 


This guide will walk you through the process of deploying a Spring Boot application on Railway(click here for free registration), a platform that offers free hosting for personal projects, without requiring a credit card.

1. Project Setup

  • Create a Spring Boot Project:

    • Use Spring Initializr (https://start.spring.io/) to generate a new Spring Boot project.
    • Select the following dependencies:
      • Spring Web: This provides the core functionality for building web applications with Spring, including RESTful services.
      • Spring Boot Starter Test: This dependency includes libraries for writing unit and integration tests for your application.
    • Choose your preferred build system (Maven or Gradle).

  • Create a Simple Controller:

    • Create a new Java class annotated with @RestController. This annotation signifies that this class will handle HTTP requests and produce responses in a format suitable for direct consumption by clients, such as JSON or XML.
    • Define a method annotated with @GetMapping. This annotation maps HTTP GET requests to a specific URL.
@RestController
public class HelloController {

    @GetMapping("/hello")
    public String hello() {
        return "Hello from Spring Boot!";
    }
}

This simple controller defines an endpoint at /hello that returns the string "Hello from Spring Boot!" when accessed.


2. Create a Railway Account

4. Deploy to Railway

  • Create a New Project:

    • Log in to your Railway account.
    • Click "New Project."
    • You have two options:
      • Import from GitHub: If your project is hosted on GitHub, connect your GitHub account and select the repository containing your Spring Boot project.
      • Upload a File: Upload the JAR file you built earlier.

  • Configure Environment Variables (Optional):

    • If your application requires any environment variables (e.g., database credentials, API keys), you can configure them in the Railway project settings. This allows you to manage sensitive information securely.

  • Deploy:

    • Click the "Deploy" button. Railway will automatically:
      • Build: If you imported from GitHub, Railway will build your project using the defined build system (Maven or Gradle).
      • Create a Container: It will create a Docker container based on your application.
      • Deploy the Container: The container will be deployed to Railway's infrastructure.

  • View Logs:

    • After deployment, you can access the logs for your application in the Railway dashboard. This helps you troubleshoot any issues and monitor the application's behavior.

  • Access Your Application:

    • Railway will provide you with a URL to access your deployed application. This URL will be in the format https://<your-project-name>.railway.app.

5. Testing

  • Make a Request:

    • Use a web browser or a tool like curl to make a GET request to the endpoint you defined in your controller (e.g., https://<your-project-name>.railway.app/hello).
    • You should see the response "Hello from Spring Boot!" in your browser or the terminal.

6. Scaling (Optional)

  • Manual Scaling: If your application experiences increased traffic, you can manually scale your deployment by increasing the number of instances running in your container.
  • Auto Scaling: Railway also offers auto-scaling features, which automatically adjust the number of instances based on traffic patterns, ensuring optimal performance and resource utilization.

Key Considerations

  • Free Tier Limitations:
    • Be aware of any limitations on the free tier of Railway, such as resource usage (CPU, memory) or concurrent connections.
    • These limitations are typically sufficient for small-scale personal projects or testing purposes.
  • Continuous Integration/Continuous Deployment (CI/CD):
    • Integrate your project with a CI/CD pipeline (e.g., GitHub Actions) to automate the build, testing, and deployment process. This streamlines development and ensures that any changes to your code are quickly and reliably deployed.
  • Security:
    • Implement appropriate security measures to protect your application from vulnerabilities, such as input validation, authentication, and authorization.
    • Regularly review and update your application's dependencies to address security issues.

Benefits of Using Railway

  • Ease of Use:
    • The platform is designed to be user-friendly, making it easy to deploy and manage applications.
  • Free Tier:
    • The free tier provides a cost-effective solution for personal projects and experimentation.
  • Scalability:
    • You can easily scale your application to handle increased traffic as needed.
  • Built-in Monitoring:
    • Railway provides basic monitoring and logging capabilities to help you track the performance and health of your application.
  • Community and Support:
    • Railway has a supportive community and documentation to assist you with any questions or issues you may encounter.

Additional Tips

  • Use a .gitignore file: Exclude sensitive files and build artifacts from your Git repository.
  • Optimize your application:
    • Minimize the size of your JAR file by excluding unnecessary dependencies.
    • Optimize your code for performance and resource efficiency.
  • Consider using a container registry:
    • If you have multiple applications or want to improve your deployment workflow, consider using a container registry like Docker Hub or GitHub Container Registry to store and manage your container images.

By following these steps, you can successfully deploy your Spring Boot application on Railway for free without requiring a credit card. This provides a valuable platform for learning, experimentation, and hosting personal projects.


Optional Steps

Environment Variables:

If your Spring Boot project needs any environment variables (e.g., database credentials, API keys), you can set them in Railway:

  1. Go to your project dashboard on Railway.
  2. Navigate to the Environment tab.
  3. Set the necessary environment variables.

These variables will be available to your application during runtime.

Configure Database (if applicable):

If your Spring Boot project uses a database (such as PostgreSQL or MySQL), you can easily add a database to your Railway project:

  1. In your Railway dashboard, click on Add Plugin and choose the database you need.
  2. Railway will set up the database and provide you with connection details, which you can use in your application.properties file or as environment variables.

Popular posts from this blog

Learn Java 8 streams with an example - print odd/even numbers from Array and List

Example 1: Java 8 program to print odd numbers from a List   import java.util.Arrays; import java.util.List; import java.util.stream.Collectors; /*Java 8 Program to find Odd Numbers from a List*/ public class DriverClass { public static void main( String [] args) { List < Integer > numbers = Arrays. asList( 1 , 4 , 8 , 40 , 11 , 22 , 33 , 99 ); List < Integer > oddNumbers = numbers.stream(). filter(o -> o % 2 != 0 ). collect(Collectors.toList()); System.out.println(oddNumbers); } } 1. Initialize List using Arrays.asList() method. Java's built-in Arrays.asList() method converts an array into a list. This method takes an array as an argument and returns a List object. 2.  Java List interface provides stream() method which returns a sequential Stream with list of Integer as its source. 3. The Java stream filter(...
Read more

Java Stream API - How to convert List of objects to another List of objects using Java streams?

Image
In this section, we will show you how to convert a List of objects to another List of objects in Java using the Java streams map(). The ‘map’ method maps each element to its corresponding result. Java Stream API   The Java Stream API provides a functional programming approach over the object oriented capabilities of Java. It is used for processing collections of objects. The Stream in Java can be defined as a sequence of elements from a source List, Set or Array. Most of the stream operations return a Stream. This avails engender a chain of stream operations(stream pipe-lining). The streams withal support the aggregate or terminal operations on the elements. for example, finding the sum or maximum element or finding the average etc...Stream operations can either be executed sequentially or parallel. when performed parallelly, it is called a parallel stream.   Stream map() Method   The Java 8 Stream map() is an intermediate operation. It converts Stream<obj1> to Str...
Read more

Registration and Login with Spring Boot + Spring Security + Thymeleaf

Image
In this section, we will learn how to create user registration and login using Spring boot, Spring security, Thymeleaf, JPA, and H2DB. The GitHub repository link is provided at the end of this tutorial. You can download the source code. Technologies used: Spring Boot 2.5.5  Spring Data JPA  Spring Security  Thymeleaf  Maven 3+  Java 17  H2 Database   User Interface User Registration Authentication Failed Authentication success Sign out Final Project Structure: Complete pom.xml: <? xml version ="1.0" encoding ="UTF-8" ?> < project xmlns ="http://maven.apache.org/POM/4.0.0" xmlns: xsi ="http://www.w3.org/2001/XMLSchema-instance" xsi :schemaLocation ="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd" > < modelVersion >4.0.0</ modelVersion > < parent > < groupId >org.springframework.boot</ groupId > < artifactId >spring-boot-starter-pare...
Read more

Java, Spring Boot Mini Project - Library Management System - Download

Image
Hello everyone, Hope you are doing well. Here, we provide a Library Management System mini-project for beginners, it's free for download. Maybe you can build more on top of this project and create your own product, that's all about you. The source code download link is provided at the end of this post. 1. Benefit of this project You could cover the following technologies and features by learning and debugging this mini project. Java 17 Java Stream Java Lamda Expressions Java Records Functional programming Object-oriented programming var Keyword in Java Generics in Java Java Switch Spring boot 2.6.4 Spring Security Thymeleaf template engine OpenCSV Spring Data JPA Server Side Pagination H2 Database  Bootstrap HTML CSS and more... 2. Objective Of Spring Boot On Library Management System The main objective of this project is to manage the details of the books, author, category, and publisher. Only Admin/Librarian will manage all these activities. Also, they can export the data in ...
Read more

ReactJS, Spring Boot JWT Authentication Example

Image
In this tutorial, we’ll create a user registration & login example using ReactJS, Spring Boot, Spring Security, and JWT authentication. You could download the source code from our Github repository, the download link is provided at the end of this tutorial. Technologies used Backend Technologies: Java 17 Spring Boot 2.7.0 Spring Security Spring Data JPA JWT H2 Database Frontend Technologies: React 17.0.1 Axios 0.27.2 Redux 4.0.5 Bootstrap 4.5.2 ReactJS - SpringBoot - JWT - Flow Backend Project Directory: Frontend Project Directory: Following is the screenshot of our application - User Registration: User Signin: Profile View: Access Resource: We will build two projects:  1. Backend:   spring-boot-security-jwt 2. Frontend: react-redux-jwt Project 1: spring-boot-security-jwt Pom.xml <?xml version = "1.0" encoding = "UTF-8" ?> <project xmlns = "http://maven.apache.org/POM/4.0.0" xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance"...
Read more

Top 5 Java ORM tools - 2024

Image
  The term ORM refers to object-relational mapping, which uses objects to adapt programming languages to database systems while allowing them to function with SQL and object-oriented programming ideas. Any kind of database management system that can accomplish object mapping to the table in the virtual system is suitable for the implementation of ORM. Java has a wide variety of ORM tools, some of which are mentioned below: 1. Hibernate Hibernate is a lightweight, open-source, non-invasive Java ORM (Object-Relational Mapping) framework that allows developers to create objects that function independently of database software and create persistence logic in any Java or JavaEE application. It offers an abstraction layer, so developers don't have to bother about implementations; Hibernate handles these tasks internally, such as connecting to databases and creating queries to carry out CRUD operations, among other things. Persistence logic development is done with it. Persistence logic r...
Read more

Java - Blowfish Encryption and decryption Example

Image
Blowfish is an encryption method developed by Bruce Schneier in 1993 as an alternative to the DES encryption method. It is significantly faster than DES and provides good encryption speed, although no effective cryptanalysis technique has been found to date. It is one of the first secure block ciphers that is not protected by any patents and is therefore freely available for anyone to use. This is a symmetric block cipher algorithm. Block size: 64 bits Key size: variable size from 32 to 448 bits number of subsections: 18 [P-array] number of rounds: 16 number of substitution blocks: 4 [each with 512 records of 32 bits each] develop  Example 1: Encryption and decryption using Blowfish import java.io.UnsupportedEncodingException; import java.nio.charset.Charset; import java.security.InvalidKeyException; import java.security.NoSuchAlgorithmException; import java.util.Base64; import javax.crypto.BadPaddingException; import javax.crypto.Cipher; import javax.crypto.IllegalBlockSiz...
Read more

Spring boot video streaming example-HTML5

Image
Hello everyone, Today we will learn how to stream MP4 video using Spring Boot and Spring Web Flux.  The Source code download link is provided at the end of this post. New, Quarkus Practice User Interface   Project Structure: G radle(build.gradle) plugins { id 'org.springframework.boot' version '2.5.4' id 'io.spring.dependency-management' version '1.0.11.RELEASE' id 'java' } group = 'com.knf.demo' version = '0.0.1-SNAPSHOT' sourceCompatibility = '11' repositories { mavenCentral() } dependencies { implementation 'org.springframework.boot:spring-boot-starter-webflux' testImplementation 'org.springframework.boot:spring-boot-starter-test' testImplementation 'io.projectreactor:reactor-test' } test { useJUnitPlatform() } Service (VideoStreamingService.java) package  com.knf.demo.service ; import org.springframework.beans.factory.annotation. Autowired ; import org.springframework...
Read more

Google Cloud Storage + Spring Boot - File Upload, Download, and Delete

Image
In this section, we will learn  how to  create a simple spring boot application to perform different file operations such as upload, download, list, and delete files from the Google Cloud Storage. 1.  A little bit of Background Google Cloud Storage Cloud Storage is a managed service for storing unstructured data. Store any amount of data and retrieve it as often as you like. More Info - click here! Spring Boot Spring Boot makes it easy to create stand-alone, production-grade Spring-based Applications that you can "just run".  More Info - click here! 2. Create a GCP Project First, Sign into the Google console at  https://console.cloud.google.com . You can create a new project by first selecting the project dropdown in the top left and selecting " New Project ". Next, specify your GCP  Project name  and  Project ID . Then  Click on the " CREATE " button. Copy " Project ID " and keep it for future purposes. 3. Create a Google Cloud Storage bucke...
Read more