Skip to content

It's the RESTful API of a simple post service. This service allows you to create different types of postal items (letter, package, parcel, postcard) and then track their delivery.

Notifications You must be signed in to change notification settings

shamshaev/post-tracker

Repository files navigation

Post Tracker

Actions Status Maintainability Test Coverage

It's the RESTful API of a simple post service. This service allows you to create different types of postal items (letter, package, parcel, postcard) and then track their delivery.

Implemented operations:

  1. Registration of postal item.
  2. Arriving of postal item to post office.
  3. Departing of postal item to post office.
  4. Receiving of postal item by recipient.
  5. Checking of tracking status, including whole delivery history of postal item.

The application is based on Spring Framework, Spring Boot and Spring Data.

screenshot-1

Application start

Link to the deployed application (active until 16/12/2024): https://post-tracker-6vd6.onrender.com/

  • you will be redirected to the integrated Swagger UI, so you can check API structure and interact with IT.
  • service database already includes all post offices (except parcel machines) from 10 cities: Moscow, Saint-Petersburg, Nizhny Novgorod, Kazan, Krasnodar, Sochi, Yekaterinburg, Novosibirsk, Naberezhnye Chelny.
  • 2 sample postal items with tracking statuses already created for the convenience.

For local application start you have to install and configure the following dependencies on your machine:

  1. Java 21
  2. Docker, Docker Compose

Start a postgresql database in a docker container:

make docker-infra-start

Run application with database in docker:

make start

About

It's the RESTful API of a simple post service. This service allows you to create different types of postal items (letter, package, parcel, postcard) and then track their delivery.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages