Skip to content

Latest commit

 

History

History

customer-management-backend

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
.mvn/wrapper
.mvn/wrapper
 
 
src
src
 
 
.gitignore
.gitignore
 
 
Dockerfile
Dockerfile
 
 
LICENSE.md
LICENSE.md
 
 
README.md
README.md
 
 
mvnw
mvnw
 
 
mvnw.cmd
mvnw.cmd
 
 
pom.xml
pom.xml
 
 

README.md

Lakeside Mutual Logo Lakeside Mutual: Customer Management Backend

The Customer Management backend provides an HTTP resource API for the Customer Self-Service frontend and the Customer Management frontend.

IDE

To view and edit the source code, we recommend the official Eclipse-based IDE Spring Tool Suite (STS). Other IDEs might work as well, but this application has only been tested with STS.

Installation

The Customer Management backend is a Spring Boot application and its dependencies are managed with Apache Maven. To get started, install Java and Maven:

  1. Make sure you have Java 8 or higher installed.
  2. Install Maven (see https://maven.apache.org for installation instructions). Note that most IDEs, such as the Spring Tool Suite, already contain a bundled copy of Maven. If this project is only built and launched from within the IDE, this step can be skipped.

Launch Application

In order to launch the Customer Management backend, you can run the command mvn spring-boot:run. When startup is completed, the output should look like this:

2018-09-06 14:52:42.792  INFO 99285 --- [  restartedMain] l.c.CustomerManagementApplication : --- Customer Management backend started ---

Alternatively, you can download and install the Spring Tool Suite:

  1. Install Spring Tool Suite (you can download the IDE from https://spring.io/tools/sts)
  2. Start Spring Tool Suite and create a new workspace or open an existing one
  3. Import the project:
    1. Go to File -> Import -> Maven -> Existing Maven Projects
    2. Select the LakesideMutual repository as the root directory
    3. Enable the check mark for the customer-management-backend project
    4. Click Finish to import the project
  4. Right-click on the project and select Run As -> Spring Boot App to start the application

By default, the Spring Boot application starts on port 8100. If this port is already used by a different application, you can change it in the src/main/resources/application.properties file.

Warnings about a java.net.ConnectException: Connection refused can safely be ignored. See the FAQ for details.

Springdoc Open API documentation

Springdoc is an automated JSON API documentation tool for APIs built with Spring. To access the documentation for the Customer Management backend, go to http://localhost:8100/swagger-ui/index.html. The native Swagger file is available at http://localhost:8100/v3/api-docs.

Enabling Persistence

By default, the database will be re-created when the application is started and any changes that were made are lost. This is configured in src/main/resources/application.properties by the following setting:

spring.jpa.hibernate.ddl-auto=create-drop

If you want to persist your changes across restarts, change the setting to:

spring.jpa.hibernate.ddl-auto=update

Spring Boot Admin

The application is configured to connect to the Spring Boot Admin on startup. See the README to learn more.