Spring-Blog

A blogging platform using Java and Spring Boot.

Prerequisites

• JDK 21
• Docker and Docker Compose
• Your favourite IDE (Recommended: IntelliJ IDEA)

Install JDK, Maven using SDKMAN

$ curl -s "https://get.sdkman.io" | bash
$ source "$HOME/.sdkman/bin/sdkman-init.sh"
$ sdk install java 21.0.1-tem
$ sdk install gradle
$ sdk install maven

Verify the prerequisites

$ java -version
$ docker info
$ docker compose version

Tech Stack:

• Java
• Spring Boot
• Spring Data JPA
• Spring Security
• PostgreSQL
• Flyway
• Thymeleaf
• JUnit 5
• Testcontainers
• Docker, Docker Compose

Features

• Home Page: Display a list of posts in createdDate desc order with pagination
• Search Posts
• Post Details View
• Add Comment to a Post
• Admin - Login
• Admin - Create a new Post using Markdown
• Admin - Edit existing Post
• Admin - Delete a Post
• Admin - Delete comment(s)

Database Design

How to?

Run Unit / Integration Tests

$ ./mvnw verify

Format code

You can format the code automatically using spotless-maven-plugin

$ ./mvnw spotless:apply // to formatting code automatically
$ ./mvnw spotless:check // to verify the code formatting

Run application locally

We can use Docker Compose or Testcontainers to start the dependent services like database, mail server, etc.

To start the application using docker-compose:

$ ./mvnw spring-boot:run

To start the application using Testcontainers:

$ ./mvnw spring-boot:test-run

The application is accessible at http://localhost:8080/.

How to contribute?

• If you find this project interesting, fork/clone it, run the application and provide feedback.
• If you find any bugs or have suggestions for improvement, then please file an issue.
• Of course, Pull Requests are most welcome.