10.2K ·GitHub
What is this?
A reference implementation of Uncle Bob's Clean Architecture in Go — a sample project showing how to structure a real backend into layered, framework-independent code.
A reference implementation of Uncle Bob's Clean Architecture in Go — a sample project showing how to structure a real backend into layered, framework-independent code.Is it a framework or a library I can import?Neither — it's a complete example project you clone, read, and adapt as a template for your own services, not a package you add to go.mod.
Neither — it's a complete example project you clone, read, and adapt as a template for your own services, not a package you add to go.mod.How do I get it running?Load article.sql into a MySQL database first, keep the source outside GOPATH since it uses Go modules, then run it directly or follow the README's docker-compose steps.
Load article.sql into a MySQL database first, keep the source outside GOPATH since it uses Go modules, then run it directly or follow the README's docker-compose steps.What do I need to have installed?Go and a MySQL instance are required; Docker with docker-compose is offered as an alternative way to run, and mockery generates the mocks used in tests.
Go and a MySQL instance are required; Docker with docker-compose is offered as an alternative way to run, and mockery generates the mocks used in tests.Is the structure on master the one I should follow?Master holds v4, whose layout diverges from v1–v3, and the author stays neutral — he recommends exploring each version's branch and picking the structure you like best.
Master holds v4, whose layout diverges from v1–v3, and the author stays neutral — he recommends exploring each version's branch and picking the structure you like best.Is this meant for learning or for production use?For learning and as a starting reference — the code itself is the artifact, and the README points to the author's Medium posts for the full architectural explanation.
For learning and as a starting reference — the code itself is the artifact, and the README points to the author's Medium posts for the full architectural explanation.What are the four layers?Models, Repository, Usecase, and Delivery. The point of the split is that business rules stay independent of frameworks, UI, the database, and any external agency.
Models, Repository, Usecase, and Delivery. The point of the split is that business rules stay independent of frameworks, UI, the database, and any external agency.Does it lock me into MySQL?No — database independence is one of the core rules. MySQL is just what the demo wires up; the idea is you can swap it for Mongo, CouchDB, or anything else without touching business rules.
No — database independence is one of the core rules. MySQL is just what the demo wires up; the idea is you can swap it for Mongo, CouchDB, or anything else without touching business rules.What does the sample app actually do?It's an article-serving demo: article.sql seeds the MySQL schema, and requests flow through the four layers to manage articles.
It's an article-serving demo: article.sql seeds the MySQL schema, and requests flow through the four layers to manage articles.What are similar projects?eShopOnWeb, awesome-software-architecture, go-patterns, domain-driven-hexagon, COLA, architect-awesome, java-design-patterns, awesome-ddd
eShopOnWeb, awesome-software-architecture, go-patterns, domain-driven-hexagon, COLA, architect-awesome, java-design-patterns, awesome-dddWhich topics is it in?clean-architecture, software-architecture, design-patterns, examples, template, architecture, best-practices, mysql, sql, golang, testing, docker-compose
clean-architecture, software-architecture, design-patterns, examples, template, architecture, best-practices, mysql, sql, golang, testing, docker-compose