This is part of a small project for learning microservices development.
Currently, the 'Shipping' application manages client addresses and finds the geographically closest Parcel Locker addresses.
Before setting up the project, you need to have a Docker infrastructure installed to run the containers, as well as the make utility.
First, start the 'Parcel Locker' microservice, followed by the 'Shipping' microservice, as the latter interacts with the former through its network.
mkdir magicdelivery && cd magicdelivery
git clone https://github.com/magicdelivery/parcel_locker.git
cd parcel_locker
make up
cd ..
git clone https://github.com/magicdelivery/shipping.git
cd shiping
make upThe application of this microservice is written in Go. The architecture is designed following Domain Driven Design (DDD) principles. The code structure is divided into the following parts:
internal/app- application logic,internal/infra- infrastructure logic,internal/domain- domain business logic.
It is expected that higher levels can call lower levels, but not vice versa.
The application layer uses the Gin framework to serve the RESTful API.
The application uses Redis for data storage and caching the results of requests to the 'Parcel Locker' microservice. Caching is implemented using the gocache library.
Communication with the 'Parcel Locker' microservice is carried out via synchronous request-response interactions over the HTTP protocol. To enhance reliability, request retries are implemented using an exponential backoff algorithm.
The testify library is used for unit testing the logic, allowing for the generation of mocks for out-of-process dependencies.
E2E testing of the API is implemented using the hurl command line tool. You can run the tests with the command make testapi, which will build and start the necessary containers and then execute the hurl test requests.
The repository includes GitHub Actions pipelines that first use a linter to check the Go code syntax, followed by the execution of unit tests. If these verification steps succeed, the application is built into a Docker container, which is then deployed to the GitHub Container Registry.
Since this is a learning project focused on microservices with Golang, I would be incredibly grateful for any advice or ideas for improvement!
MIT