{"id":15044202,"url":"https://github.com/rapter1990/couriertracking","last_synced_at":"2026-01-04T17:51:50.514Z","repository":{"id":250277824,"uuid":"833991967","full_name":"Rapter1990/couriertracking","owner":"Rapter1990","description":"Case Study - Courier Tracking (Kotlin, Spring Boot, Mapstruct, JUnit Tests, Integration Tests, Docker, CI/CD - Github Actions, Gradle)","archived":false,"fork":false,"pushed_at":"2024-07-31T05:30:21.000Z","size":3932,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-29T06:51:27.315Z","etag":null,"topics":["docker","docker-compose","dockerfile","github-actions","gradle","integration-test","junit","kotlin","mapstruct","mysql","openapi","postman","spring-boot","testcontainer"],"latest_commit_sha":null,"homepage":"","language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Rapter1990.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-07-26T07:37:59.000Z","updated_at":"2024-10-12T18:32:17.000Z","dependencies_parsed_at":"2024-09-25T01:52:57.116Z","dependency_job_id":"c447e31d-04ad-4d6f-a083-8214a8e666e3","html_url":"https://github.com/Rapter1990/couriertracking","commit_stats":null,"previous_names":["rapter1990/couriertracking"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Rapter1990%2Fcouriertracking","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Rapter1990%2Fcouriertracking/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Rapter1990%2Fcouriertracking/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Rapter1990%2Fcouriertracking/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Rapter1990","download_url":"https://codeload.github.com/Rapter1990/couriertracking/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245186922,"owners_count":20574554,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docker","docker-compose","dockerfile","github-actions","gradle","integration-test","junit","kotlin","mapstruct","mysql","openapi","postman","spring-boot","testcontainer"],"created_at":"2024-09-24T20:50:12.407Z","updated_at":"2026-01-04T17:51:50.459Z","avatar_url":"https://github.com/Rapter1990.png","language":"Kotlin","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Case Study - Courier Tracking (Spring Boot - Kotlin)\n\n\u003cp align=\"center\"\u003e\n    \u003cimg src=\"screenshots/spring_boot_microservices_courier_tracking_main.png\" alt=\"Main Information\" width=\"800\" height=\"450\"\u003e\n\u003c/p\u003e\n\n### 📖 Information\n\n\u003cul style=\"list-style-type:disc\"\u003e\n  \u003cli\u003eThis project demonstrates a \u003cb\u003eSpring Boot\u003c/b\u003e application for managing courier travel data. It logs courier locations, tracks travel distances, and manages interactions with stores within a specific radius.\u003c/li\u003e\n  \u003cli\u003eThe application incorporates various design patterns including \u003cb\u003eFacade\u003c/b\u003e, \u003cb\u003eBuilder\u003c/b\u003e, and \u003cb\u003eStrategy\u003c/b\u003e patterns, and provides endpoints for logging locations, retrieving travel data, and querying total travel distances.\u003c/li\u003e\n  \u003cli\u003eLogging Courier Locations:\n    \u003cul\u003e\n      \u003cli\u003eThe application logs a courier's location details (time, latitude, longitude) whenever they enter within a 100-meter radius of a Store.\u003c/li\u003e\n      \u003cli\u003eReentries within one minute to the same store are not counted.\u003c/li\u003e\n    \u003c/ul\u003e\n  \u003c/li\u003e\n  \u003cli\u003eQuerying Travel Data:\n    \u003cul\u003e\n      \u003cli\u003eIt provides endpoints to retrieve past travel data of couriers.\u003c/li\u003e\n      \u003cli\u003eIncludes filtering by store name and time range.\u003c/li\u003e\n    \u003c/ul\u003e\n  \u003c/li\u003e\n  \u003cli\u003eCalculating Travel Distances:\n    \u003cul\u003e\n      \u003cli\u003eThe application can calculate and return the total travel distance covered by a courier.\u003c/li\u003e\n    \u003c/ul\u003e\n  \u003c/li\u003e\n\u003c/ul\u003e\n\n\n### Explore Rest APIs\n\nEndpoints Summary\n\u003ctable style=\"width:100%\"\u003e\n  \u003ctr\u003e\n      \u003cth\u003eMethod\u003c/th\u003e\n      \u003cth\u003eUrl\u003c/th\u003e\n      \u003cth\u003eDescription\u003c/th\u003e\n      \u003cth\u003eRequest Body\u003c/th\u003e\n      \u003cth\u003ePath Variable\u003c/th\u003e\n      \u003cth\u003eResponse\u003c/th\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n      \u003ctd\u003ePOST\u003c/td\u003e\n      \u003ctd\u003e/api/couriers/log-location\u003c/td\u003e\n      \u003ctd\u003eLog courier's location.\u003c/td\u003e\n      \u003ctd\u003eLogCourierLocationRequest\u003c/td\u003e\n      \u003ctd\u003eNone\u003c/td\u003e\n      \u003ctd\u003eCustomResponse\u0026lt;String\u0026gt;\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n      \u003ctd\u003eGET\u003c/td\u003e\n      \u003ctd\u003e/api/couriers/travels/{courierId}\u003c/td\u003e\n      \u003ctd\u003eGet past travels of a courier by courier ID.\u003c/td\u003e\n      \u003ctd\u003eNone\u003c/td\u003e\n      \u003ctd\u003ecourierId (UUID)\u003c/td\u003e\n      \u003ctd\u003eCustomResponse\u0026lt;List\u0026lt;CourierResponse\u0026gt;\u0026gt;\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n      \u003ctd\u003eGET\u003c/td\u003e\n      \u003ctd\u003e/api/couriers/travels\u003c/td\u003e\n      \u003ctd\u003eGet travels of a courier by courier ID, store name, and time range.\u003c/td\u003e\n      \u003ctd\u003eTravelQueryRequest\u003c/td\u003e\n      \u003ctd\u003eNone\u003c/td\u003e\n      \u003ctd\u003eCustomResponse\u0026lt;List\u0026lt;CourierResponse\u0026gt;\u0026gt;\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n      \u003ctd\u003eGET\u003c/td\u003e\n      \u003ctd\u003e/api/couriers/travels/{courierId}/total-distance\u003c/td\u003e\n      \u003ctd\u003eGet total travel distance of a courier by courier ID.\u003c/td\u003e\n      \u003ctd\u003eNone\u003c/td\u003e\n      \u003ctd\u003ecourierId (UUID)\u003c/td\u003e\n      \u003ctd\u003eCustomResponse\u0026lt;String\u0026gt;\u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n\n### Technologies\n\n---\n- Kotlin\n- Spring Boot 3.0\n- Restful API\n- Mapstruct\n- Open Api (Swagger)\n- Gradle\n- Junit5\n- Mockito\n- Integration Tests\n- Docker\n- Docker Compose\n- CI/CD (Github Actions)\n- Postman\n- TestContainer\n- MySQL\n\n### Postman\n\n```\nImport postman collection under postman_collection folder\n```\n\n\n### Prerequisites\n\n#### Define Variable in .env file for product service and user service\n\n```\nDATABASE_USERNAME={DATABASE_USERNAME}\nDATABASE_PASSWORD={DATABASE_PASSWORD}\n```\n\n### Open Api (Swagger)\n\n```\nhttp://localhost:1231/swagger-ui/index.html\n```\n\n---\n- Gradle or Docker\n---\n\n\n### Docker Run\nThe 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.\n\nPlease follow directions shown below in order to build and run the application with Docker Compose file;\n\n```sh\n$ cd couriertracking\n$ docker-compose up -d\n```\n\nIf you change anything in the project and run it on Docker, you can also use this command shown below\n\n```sh\n$ cd couriertracking\n$ docker-compose up --build\n```\n\n---\n### Gradle Run\nTo build and run the application with `Gradle`, please follow the directions shown below;\n\n```sh\n$ cd couriertracking\n$ ./gradlew clean build\n$ ./gradlew bootRun\n```\n\n---\n### Docker Image Location\n\n```\nhttps://hub.docker.com/repository/docker/noyandocker/couriertracking/general\n```\n\n### Screenshots\n\n\u003cdetails\u003e\n\u003csummary\u003eClick here to show the screenshots of project\u003c/summary\u003e\n    \u003cp\u003e Figure 1 \u003c/p\u003e\n    \u003cimg src =\"screenshots/screenshot1.PNG\"\u003e\n    \u003cp\u003e Figure 2 \u003c/p\u003e\n    \u003cimg src =\"screenshots/screenshot2.PNG\"\u003e\n    \u003cp\u003e Figure 3 \u003c/p\u003e\n    \u003cimg src =\"screenshots/screenshot3.PNG\"\u003e\n    \u003cp\u003e Figure 4 \u003c/p\u003e\n    \u003cimg src =\"screenshots/screenshot4.PNG\"\u003e\n    \u003cp\u003e Figure 5 \u003c/p\u003e\n    \u003cimg src =\"screenshots/screenshot5.PNG\"\u003e\n    \u003cp\u003e Figure 6 \u003c/p\u003e\n    \u003cimg src =\"screenshots/screenshot6.PNG\"\u003e\n    \u003cp\u003e Figure 7 \u003c/p\u003e\n    \u003cimg src =\"screenshots/screenshot7.PNG\"\u003e\n    \u003cp\u003e Figure 8 \u003c/p\u003e\n    \u003cimg src =\"screenshots/screenshot8.PNG\"\u003e\n    \u003cp\u003e Figure 9 \u003c/p\u003e\n    \u003cimg src =\"screenshots/screenshot9.PNG\"\u003e\n    \u003cp\u003e Figure 10 \u003c/p\u003e\n    \u003cimg src =\"screenshots/screenshot10.PNG\"\u003e\n\u003c/details\u003e\n\n\n### Contributors\n\n- [Sercan Noyan Germiyanoğlu](https://github.com/Rapter1990)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frapter1990%2Fcouriertracking","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frapter1990%2Fcouriertracking","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frapter1990%2Fcouriertracking/lists"}