xebia-os / spring-boot-react-maven-starter

A multi module Spring Boot React starter for building real-world enterprises apps

spring-boot-react-maven-starter

This is a multi-module Spring Boot React Apache Maven starter app with good defaults. The react app is built using create-react-app.

This project provides a productive setup for building Spring Boot React applications. The application is divided into two Maven modules:

1. api: This contains Java code of the application.
2. ui: This contains all react JavaScript code of the application.

Running the full application

You can build the package as a single artifact by running the ./mvnw clean install. Next, you can run the application by executing:

$ java -jar api/target/api-0.1.0-SNAPSHOT.jar

The application will be accessible at http://localhost:8080.

Features

This starter comes bundled with the following features:

1. Multi module Maven project: A multi module project to modularize backend and frontend code separately.
2. Maven wrapper: So, you don't need to install Maven on your machine.
3. Checkstyle: Enforce sane coding standard guidelines.
4. CORS enabled: A global configuration is added to enable CORS so that frontend can work seamlessly with backend during development.

Running the backend for development mode

There are multiple ways to run the backend. For development, you can use your favorite IDE and run the com.xebia.starter.Application. As soon as your code compiles, Spring Boot DevTools will reload the code.

You can also run the application using Maven.

$ cd api
$  ../mvnw spring-boot:run

Running the frontend for development mode

You will need Node 12+ and npm to run the dev server and build the project.

$ cd ui
$ npm start

Docker Setup

To build the docker images and start the containers using Docker Compose run the following command. This will work in the *nix systems.

$ sh docker.sh

You can view running docker containers by executing following command.

$ docker ps

To stop and remove all docker container you have to run following command. This command should be run from project root.

$ docker-compose stop && docker-compose rm --force

spring-boot-react-maven-starter's Issues

Is this project being maintained?

Add ArchUnit tests to this boilerplate as well

Would it be a good idea to bake in the ArchUnit tests into this boilerplate so it comes out of the box? Should I pick that up?

Add contract testing skeleton to the starter

Would this be a good idea? It is much touted nowadays and this is needed if there are multiple APIs.
A different approach here might be to bake in Pact instead and have contract tests between the UI and the API.
Would this be of value?

WAR packaging

Thank you for putting this together. I will be using it as a base for a web app with a mysql database. I am planning to deploy it in Tomcat. I was wondering if this will work "out of the box" if I just change the packaging from "pom" to "war" in the main pom file and just rebuild it and deploy?

404 error

Hi,

I am still getting 404 error. Can you please help to resolve this?

Update README.md to include instructions for pulling jars from GH Packages

This should go in the README so people don't go hunting over the Internet to build the skeleton with the ArchUnit dependency locally. Or worse, comment it out altogether.