Spring Service Scaffold

A scaffold for a web service operating with a Spring Framework backend, reactjs as frontend and a continuous testing and building pipeline, built on gradle, junit5 and GitHub actions.

Components

Backend

This repository builds a Java 17 application serving a webapp and web service using the Spring Framework on Reactive Stack. See ApiController class for the implementation of a controller.

Frontend

A reactjs application created with the create-react-app script.

Continuous Building/Testing

Besides JUnit 5, this scaffold employs the following tools for building and testing:

1. Gradle plugin for the OWASP dependency check, to spot vulnerabilities in the JARs dependencies.
2. Gradle plugin for Checkstyle to verify code formatting.
3. Gradle JIB plugin for building a docker image out of the JAR.
4. Dependabot to update outdated gradle dependencies.
5. Spring Boot Integration for Sentry.

TODOs

After forking the repository to build your new web services, complete the following TODOs:

• Rename the project in the following locations:
  • settings.gradle.tks, property rootProject.name
  • application.yml, property spring.application.name
  • package.json, property name
• Change the version of the project in:
  • build.gradle.tks, property version
  • package.json, property version
• Rename the package from org.example to your organisation/application name scheme.
• Rename the group name in build.gradle.tks to the package name.
• Set the sentry DSN of your project in application.yml