java_code_base

Introduction

This document is designed to help you get up and running quickly with Java projects.

Setting environment part

Before you begin, make sure your development environment includes the following tools and software:

• Java Development Kit (JDK): JDK 17 or newer is recommended.
• Apache Maven: Used to build and manage project dependencies.
• Visual Studio Code：Used for editing code and debugging.
• Postgres: Used as database

Build Project

mvn package

run Project

mvn spring-boot:run

Debug Mode

use vscode built-in debug mode.

Lint check

Use VS Code’s EditorConfig extension for lint checking

please use vscode extension => "EditorConfig for VS Code"

CLI Lint check

Run the following command to perform a Checkstyle check:

mvn checkstyle:check

unit test

It will generate a coverage report at /target/site/jacoco/index.html

mvn clean test

swagger

Access the Swagger UI to view and test API endpoints:

http://localhost:8080/swagger-ui/index.html