Case Study - Courier Tracking (Spring Boot - Kotlin)

📖 Information

Explore Rest APIs

Endpoints Summary

Technologies

• Kotlin
• Spring Boot 3.0
• Restful API
• Mapstruct
• Open Api (Swagger)
• Gradle
• Junit5
• Mockito
• Integration Tests
• Docker
• Docker Compose
• CI/CD (Github Actions)
• Postman
• TestContainer
• MySQL

Postman

Import postman collection under postman_collection folder

Prerequisites

Define Variable in .env file for product service and user service

DATABASE_USERNAME={DATABASE_USERNAME}
DATABASE_PASSWORD={DATABASE_PASSWORD}

Open Api (Swagger)

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

• Gradle or Docker

Docker Run

The application can be built and run by the Docker engine. The Dockerfile has multistage build, so you do not need to build and run separately.

Please follow directions shown below in order to build and run the application with Docker Compose file;

$ cd couriertracking
$ docker-compose up -d

If you change anything in the project and run it on Docker, you can also use this command shown below

$ cd couriertracking
$ docker-compose up --build

Gradle Run

To build and run the application with Gradle, please follow the directions shown below;

$ cd couriertracking
$ ./gradlew clean build
$ ./gradlew bootRun

Docker Image Location

https://hub.docker.com/repository/docker/noyandocker/couriertracking/general

Screenshots

Contributors

• Sercan Noyan Germiyanoğlu