lsantos2000/srehi-mgmt-registry

srehi-mgmt-registry Santos Real Estate Proof of Concept (POC) webapp using SpringBoot

Santos Real Estate Holdings Inc. - SpringBoot Proof of Concept (POC), August 2023

Based and extended from a SpringBoot starter project

By Leonardo Santos-Macias email: LSantos2000@gmail.com

Summary

Santos Real Estate Proof of Concept (POC) webapp using SpringBoot, Maven, Gradle, Java 17 or greater, Docker, H2, MySQL, PostGress, etc.

Running srehi-registry locally

srehi-mgmt-registry is a Spring Boot application built using Maven or Gradle. You can build a jar file and run it from the command line (it should work just as well with Java 17 or newer):

git clone https://github.com/lsantos2000/srehi/srehi-mgmt-registry.git
cd srehi-mgmt-registry
./mvnw package
java -jar target/*.jar

You can then access srehi-registry at http://localhost:8080/

Or you can run it from Maven directly using the Spring Boot Maven plugin. If you do this, it will pick up changes that you make in the project immediately (changes to Java source files require a compile as well - most people use an IDE for this):

./mvnw spring-boot:run

NOTE: If you prefer to use Gradle, you can build the app using ./gradlew build and look for the jar file in build/libs.

Building a Container

There is no Dockerfile in this project. You can build a container image (if you have a docker daemon) using the Spring Boot build plugin:

./mvnw spring-boot:build-image

Database configuration

In its default configuration, srehi-mgmt-registry uses an in-memory database (H2) which gets populated at startup with data. The h2 console is exposed at http://localhost:8080/h2-console, and it is possible to inspect the content of the database using the jdbc:h2:mem:testdb url.

A similar setup is provided for MySQL and PostgreSQL if a persistent database configuration is needed. Note that whenever the database type changes, the app needs to run with a different profile: spring.profiles.active=mysql for MySQL or spring.profiles.active=postgres for PostgreSQL.

You can start MySQL or PostgreSQL locally with whatever installer works for your OS or use docker:

docker run -e MYSQL_USER=petclinic -e MYSQL_PASSWORD=petclinic -e MYSQL_ROOT_PASSWORD=root -e MYSQL_DATABASE=petclinic -p 3306:3306 mysql:8.0

or

docker run -e POSTGRES_USER=petclinic -e POSTGRES_PASSWORD=petclinic -e POSTGRES_DB=petclinic -p 5432:5432 postgres:15.2

Further documentation is provided for MySQL and for PostgreSQL.

Instead of vanilla docker you can also use the provided docker-compose.yml file to start the database containers. Each one has a profile just like the Spring profile:

$ docker-compose --profile mysql up

or

$ docker-compose --profile postgres up

Test Applications

At development time we recommend you use the test applications set up as main() methods in PetClinicIntegrationTests (using the default H2 database and also adding Spring Boot devtools), MySqlTestApplication and PostgresIntegrationTests. These are set up so that you can run the apps in your IDE and get fast feedback, and also run the same classes as integration tests against the respective database. The MySql integration tests use Testcontainers to start the database in a Docker container, and the Postgres tests use Docker Compose to do the same thing.

Compiling the CSS

There is a petclinic.css in src/main/resources/static/resources/css. It was generated from the petclinic.scss source, combined with the Bootstrap library. If you make changes to the scss, or upgrade Bootstrap, you will need to re-compile the CSS resources using the Maven profile "css", i.e. ./mvnw package -P css. There is no build profile for Gradle to compile the CSS.

Working with srehi-registry in your IDE

Prerequisites

The following items should be installed in your system:

• Java 17 or newer (full JDK, not a JRE).
• git command line tool
• Your preferred IDE
  • Eclipse with the m2e plugin. Note: when m2e is available, there is an m2 icon in Help -> About dialog. If m2e is not there, follow the install process here
  • Spring Tools Suite (STS)
  • IntelliJ IDEA
  • VS Code

Steps:

1. On the command line run:

   git clone https://github.com/spring-projects/srehi-mgmt-registry.git
   

2. Inside Eclipse or STS:

   File -> Import -> Maven -> Existing Maven project
   

   Then either build on the command line ./mvnw generate-resources or use the Eclipse launcher (right click on project and Run As -> Maven install) to generate the css. Run the application main method by right-clicking on it and choosing Run As -> Java Application.

3. Inside IntelliJ IDEA In the main menu, choose File -> Open and select the srehi-mgmt-registry pom.xml. Click on the Open button.

   CSS files are generated from the Maven build. You can build them on the command line ./mvnw generate-resources or right-click on the srehi-registry project then Maven -> Generates sources and Update Folders.

   A run configuration named srehi-registryApplication should have been created for you if you're using a recent Ultimate version. Otherwise, run the application by right-clicking on the srehi-registryApplication main class and choosing Run 'srehi-registryApplication'.

4. Navigate to srehi-registry

   Visit http://localhost:8080 in your browser.