Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sivaprasadreddy/spring-boot-application-template

Spring Boot Application Template
https://github.com/sivaprasadreddy/spring-boot-application-template

Last synced: 15 days ago
JSON representation

Spring Boot Application Template

Host: GitHub
URL: https://github.com/sivaprasadreddy/spring-boot-application-template
Owner: sivaprasadreddy
License: apache-2.0
Created: 2023-04-23T04:21:51.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2024-02-03T04:35:16.000Z (9 months ago)
Last Synced: 2024-10-21T05:10:47.012Z (23 days ago)
Language: Java
Size: 264 KB
Stars: 32
Watchers: 3
Forks: 4
Open Issues: 12
Metadata Files:
- Readme: README.gradle.md
- License: LICENSE

Awesome Lists containing this project

README

# Spring Boot Application Template
This repository is a template for creating a Spring Boot application with commonly used features pre-configured.

[![Maven Build](https://github.com/sivaprasadreddy/spring-boot-application-template/actions/workflows/ci-maven.yml/badge.svg)](https://github.com/sivaprasadreddy/spring-boot-application-template/actions/workflows/ci-maven.yml)
[![Gradle Build](https://github.com/sivaprasadreddy/spring-boot-application-template/actions/workflows/ci-gradle.yml/badge.svg)](https://github.com/sivaprasadreddy/spring-boot-application-template/actions/workflows/ci-gradle.yml)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=sivaprasadreddy_spring-boot-application-template&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=sivaprasadreddy_spring-boot-application-template)

## Features
* Spring Boot
* Spring Data JPA
* PostgreSQL
* Flyway for DB migration
* Springdoc Open API
* JaCoCo code coverage check
* SonarQube code quality check
* OWASP Dependency Check
* JUnit 5
* Testcontainers for testing & Local Dev
* GitHub Actions
* DockerCompose Deployment

## Prerequisites
* Install Java using [SDKMAN](https://sdkman.io/)

```shell
$ curl -s "https://get.sdkman.io" | bash
$ source "$HOME/.sdkman/bin/sdkman-init.sh"
$ sdk version
$ sdk env install
```
* Install Docker : https://docs.docker.com/get-docker/

## Getting Started

```shell
$ git clone https://github.com/sivaprasadreddy/spring-boot-application-template.git
$ cd spring-boot-application-template
$ ./gradlew build
```

To run the application from IDE, run `TestApplication.java` under `src/test/java`.

## How to?
This section describes how to perform various tasks.

### Code Formatting
The [Spotless for Gradle](https://github.com/diffplug/spotless/tree/main/plugin-gradle) combined with
[palantir-java-format](https://github.com/palantir/palantir-java-format) is used to format source code
and is configured to automatically check code formatting while building the application.

```shell
$ ./gradlew spotlessApply <- to format source code
$ ./gradlew spotlessCheck <- to verify source code formatting
```

### JaCoCo Code Coverage
The [The JaCoCo Plugin](https://docs.gradle.org/current/userguide/jacoco_plugin.html) is used to verify the test code coverage.
If the expected code coverage is not met (default is set to 80%) then the build will fail.

```shell
$ ./gradlew jacocoTestCoverageVerification
```

### SonarQube Quality Check
The [Gradle SonarQube Plugin](https://plugins.gradle.org/plugin/org.sonarqube) is configured and
is configured to run on [SonarCloud](https://sonarcloud.io/).

You can configure the sonar properties in `sonar-project.properties` and run the sonar scan as follows:

```shell
$ ./gradlew sonarqube -Dsonar.login=$SONAR_TOKEN
```

### OWASP Dependency Check
The [OWASP dependency-check-gradle plugin](http://jeremylong.github.io/DependencyCheck/dependency-check-gradle/index.html) is used to check
for security vulnerabilities in the used libraries.

```shell
$ ./gradlew dependencyCheckAnalyze
```
You can see the generated report at `target/dependency-check-report.html`

### Create Docker Image
The [spring-boot-gradle-plugin](https://docs.spring.io/spring-boot/docs/current/gradle-plugin/reference/htmlsingle/) provides
the capability to create an [OCI image](https://github.com/opencontainers/image-spec) from a jar or war file using [Cloud Native Buildpacks](https://buildpacks.io/) (CNB).

```shell
$ ./gradlew bootBuildImage --imageName=$DOCKER_USERNAME/$DOCKER_IMAGE_NAME
```

### Run application using docker-compose
Once the application docker image is created, you can run the application using docker-compose as follows:

```shell
$ cd deployment/docker-compose
$ docker compose up -d
```

Now the application should be accessible at http://localhost:8080/