tree-search-sample

A simple project based on Java 11, Spring Boot, H2, H2GIS, Hibernate Spatial, and JUnit 5.

Getting Started

These instructions will get you a copy of the project and run on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

What things you need to run the project:

Java Development Kit (JDK 11 or newer)
Maven
Docker (if you want to run the application using the Docker image)

Installing

Clone the repository:

git clone https://github.com/rezaep/tree-search-sample

Use Maven build tool to compile and build the project:

mvn clean compile

Running the tests

Unit tests

To run unit tests use the following command:

mvn test

Running the application

Run using Java

To run the application using Java, run the following command:

java -jar target/tree-search-1.0.0.jar

Run using Maven and Spring Boot plugin

To run the application using Spring boot maven-plugin, run the following command:

mvn spring-boot:run

Run using Docker

To package the Jar file inside a Docker image, use the following commands:

mvn clean package
docker build -t image:tag . (e.g. subliz/tree-search:latest)

To run the application using Docker, run the following command:

docker run -d -p 8080:8080 image:tag (e.g. subliz/tree-search:latest)

Start working with APIs

Swagger generates documentation of REST APIs, which is accessible using this link.

Authors

• Reza Ebrahimpour - Github

License

This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details