Vending Machine

✅ This is an API for a vending machine, allowing users with a “seller” role to add, update or remove products, while users with a “buyer” role can deposit coins into the machine and make purchases. This vending machine only accept 5, 10, 20, 50 and 100 🪙 cent coins.

📜 Description

This is an example of implementation of Clean Architecture in Go (Golang) project.

🔰 Rule of Clean Architecture by Uncle Bob

• Independent of Frameworks. The architecture does not depend on the existence of some library of feature laden software. This allows you to use such frameworks as tools, rather than having to cram your system into their limited constraints.
• Testable. The business rules can be tested without the UI, Database, Web Server, or any other external element.
• Independent of UI. The UI can change easily, without changing the rest of the system. A Web UI could be replaced with a console UI, for example, without changing the business rules.
• Independent of Database. You can swap out Oracle or SQL Server, for Mongo, BigTable, CouchDB, or something else. Your business rules are not bound to the database.
• Independent of any external agency. In fact your business rules simply don’t know anything at all about the outside world.

📚 More at Uncle Bob clean-architecture

🔰 This project has 4 Domain layer :

• Entities Layer
• Data(Repository) Layer
• Service(Usecase) Layer
• Presentation(Delivery) Layer

📚 More at Martin Fowler PresentationDomainDataLayering

🗺 The Diagram:

🏃🏽‍♂️ How To Run This Project

⚠️ Since the project already use Go Module, I recommend to put the source code in any folder except GOPATH.

🧪 Run the Testing

$ make test

🐳 Run the Applications

Here is the steps to run it with docker-compose

# move to directory
$ cd workspace
# Clone it
$ git clone https://github.com/apm-dev/vending-machine.git
# move to project
$ cd vending-machine
# (optional) Build the docker image first
$ make docker
# Run the application
$ make run
# check if the containers are running
$ docker ps
# See the logs
docker logs --follow vending_machine_api
# Download postman-collection.json and test it
$ curl localhost:9090/products/
# Stop
$ make stop

postman-collection

🛠 Tools Used:

In this project, I use some tools listed below. But you can use any similar library that have the same purposes. But, well, different library will have different implementation type. Just be creative and use anything that you really need.

• All libraries listed in go.mod
• "github.com/vektra/mockery". To Generate Mocks for testing needs.