evrone · anatolypaw · Aug 11, 2024
diff --git a/README.md b/README.md
@@ -1,7 +1,9 @@
 ![Go Clean Template](docs/img/logo.svg)
 
 # Go Clean template
-[🇨🇳中文](README_CN.md)
+
+[🇨🇳 中文](README_CN.md)
+[🇷🇺 RU](README_RU.md)
 
 Clean Architecture template for Golang services
 
@@ -11,7 +13,9 @@ Clean Architecture template for Golang services
 [![codecov](https://codecov.io/gh/evrone/go-clean-template/branch/master/graph/badge.svg?token=XE3E0X3EVQ)](https://codecov.io/gh/evrone/go-clean-template)
 
 ## Overview
+
 The purpose of the template is to show:
+
 - how to organize a project and prevent it from turning into spaghetti code
 - where to store business logic so that it remains independent, clean, and extensible
 - how not to lose control when a microservice grows
@@ -21,13 +25,16 @@ Using the principles of Robert Martin (aka Uncle Bob).
 [Go-clean-template](https://evrone.com/go-clean-template?utm_source=github&utm_campaign=go-clean-template) is created & supported by [Evrone](https://evrone.com/?utm_source=github&utm_campaign=go-clean-template).
 
 ## Content
+
 - [Quick start](#quick-start)
 - [Project structure](#project-structure)
 - [Dependency Injection](#dependency-injection)
 - [Clean Architecture](#clean-architecture)
 
 ## Quick start
+
 Local development:
+
 ```sh
 # Postgres, RabbitMQ
 $ make compose-up
@@ -36,17 +43,21 @@ $ make run
 ```
 
 Integration tests (can be run in CI):
+
 ```sh
 # DB, app + migrations, integration tests
 $ make compose-up-integration-test
 ```
 
 ## Project structure
+
 ### `cmd/app/main.go`
+
 Configuration and logger initialization. Then the main function "continues" in
 `internal/app/app.go`.
 
 ### `config`
+
 Configuration. First, `config.yml` is read, then environment variables overwrite the yaml config if they match.
 The config structure is in the `config.go`.
 The `env-required: true` tag obliges you to specify a value (either in yaml, or in environment variables).
@@ -59,15 +70,18 @@ reading the entire config from ENV.
 It is assumed that default values are in yaml, and security-sensitive variables are defined in ENV.
 
 ### `docs`
+
 Swagger documentation. Auto-generated by [swag](https://github.com/swaggo/swag) library.
 You don't need to correct anything by yourself.
 
 ### `integration-test`
+
 Integration tests.
 They are launched as a separate container, next to the application container.
 It is convenient to test the Rest API using [go-hit](https://github.com/Eun/go-hit).
 
 ### `internal/app`
+
 There is always one _Run_ function in the `app.go` file, which "continues" the _main_ function.
 
 This is where all the main objects are created.
@@ -89,19 +103,24 @@ $ go run -tags migrate ./cmd/app
 ```
 
 ### `internal/controller`
+
 Server handler layer (MVC controllers). The template shows 2 servers:
+
 - RPC (RabbitMQ as transport)
 - REST http (Gin framework)
 
 Server routers are written in the same style:
+
 - Handlers are grouped by area of application (by a common basis)
 - For each group, its own router structure is created, the methods of which process paths
 - The structure of the business logic is injected into the router structure, which will be called by the handlers
 
 #### `internal/controller/http`
+
 Simple REST versioning.
 For v2, we will need to add the `http/v2` folder with the same content.
 And in the file `internal/app` add the line:
+
 ```go
 handler := gin.New()
 v1.NewRouter(handler, t)
@@ -113,11 +132,14 @@ Instead of Gin, you can use any other http framework or even the standard `net/h
 In `v1/router.go` and above the handler methods, there are comments for generating swagger documentation using [swag](https://github.com/swaggo/swag).
 
 ### `internal/entity`
+
 Entities of business logic (models) can be used in any layer.
 There can also be methods, for example, for validation.
 
 ### `internal/usecase`
+
 Business logic.
+
 - Methods are grouped by area of application (on a common basis)
 - Each group has its own structure
 - One file - one structure
@@ -126,20 +148,25 @@ Repositories, webapi, rpc, and other business logic structures are injected into
 (see [Dependency Injection](#dependency-injection)).
 
 #### `internal/usecase/repo`
+
 A repository is an abstract storage (database) that business logic works with.
 
 #### `internal/usecase/webapi`
+
 It is an abstract web API that business logic works with.
 For example, it could be another microservice that business logic accesses via the REST API.
 The package name changes depending on the purpose.
 
 ### `pkg/rabbitmq`
+
 RabbitMQ RPC pattern:
+
 - There is no routing inside RabbitMQ
 - Exchange fanout is used, to which 1 exclusive queue is bound, this is the most productive config
 - Reconnect on the loss of connection
 
 ## Dependency Injection
+
 In order to remove the dependence of business logic on external packages, dependency injection is used.
 
 For example, through the New constructor, we inject the dependency into the structure of the business logic.
@@ -178,23 +205,28 @@ It will also allow us to do auto-generation of mocks (for example with [mockery]
 > If the new component implements the interface, nothing needs to be changed in the business logic.
 
 ## Clean Architecture
+
 ### Key idea
+
 Programmers realize the optimal architecture for an application after most of the code has been written.
 
 > A good architecture allows decisions to be delayed to as late as possible.
 
 ### The main principle
-Dependency Inversion (the same one from SOLID) is the principle of dependency inversion.
+
+Dependency Inversion (the same one from SOLID) is the principle of dependency injection.
 The direction of dependencies goes from the outer layer to the inner layer.
 Due to this, business logic and entities remain independent from other parts of the system.
 
 So, the application is divided into 2 layers, internal and external:
+
 1. **Business logic** (Go standard library).
 2. **Tools** (databases, servers, message brokers, any other packages and frameworks).
 
 ![Clean Architecture](docs/img/layers-1.png)
 
 **The inner layer** with business logic should be clean. It should:
+
 - Not have package imports from the outer layer.
 - Use only the capabilities of the standard library.
 - Make calls to the outer layer through the interface (!).
@@ -203,6 +235,7 @@ The business logic doesn't know anything about Postgres or a specific web API.
 Business logic has an interface for working with an _abstract_ database or _abstract_ web API.
 
 **The outer layer** has other limitations:
+
 - All components of this layer are unaware of each other's existence. How to call another from one tool? Not directly, only through the inner layer of business logic.
 - All calls to the inner layer are made through the interface (!).
 - Data is transferred in a format that is convenient for business logic (`internal/entity`).
@@ -217,12 +250,14 @@ The communication between them is carried out through `usecase` (business logic)
            usecase < repository (Postgres)
     HTTP < usecase
 ```
+
 The symbols > and < show the intersection of layer boundaries through Interfaces.
 The same is shown in the picture:
 
 ![Example](docs/img/example-http-db.png)
 
 Or more complex business logic:
+
 ```
     HTTP > usecase
            usecase > repository
@@ -237,20 +272,22 @@ Or more complex business logic:
 ```
 
 ### Layers
+
 ![Example](docs/img/layers-2.png)
 
 ### Clean Architecture Terminology
+
 - **Entities** are structures that business logic operates on.
   They are located in the `internal/entity` folder.
   In MVC terms, entities are models.
-
 - **Use Cases** is business logic located in `internal/usecase`.
 
 The layer with which business logic directly interacts is usually called the _infrastructure_ layer.
 These can be repositories `internal/usecase/repo`, external webapi `internal/usecase/webapi`, any pkg, and other microservices.
 In the template, the _infrastructure_ packages are located inside `internal/usecase`.
 
 You can choose how to call the entry points as you wish. The options are:
+
 - controller (in our case)
 - delivery
 - transport
@@ -260,28 +297,31 @@ You can choose how to call the entry points as you wish. The options are:
 - input
 
 ### Additional layers
+
 The classic version of [Clean Architecture](https://blog.cleancoder.com/uncle-bob/2012/08/13/the-clean-architecture.html) was designed for building large monolithic applications and has 4 layers.
 
 In the original version, the outer layer is divided into two more, which also have an inversion of dependencies
 to each other (directed inward) and communicate through interfaces.
 
 The inner layer is also divided into two (with separation of interfaces), in the case of complex logic.
 
-_______________________________
+---
 
 Complex tools can be divided into additional layers.
 However, you should add layers only if really necessary.
 
 ### Alternative approaches
+
 In addition to Clean architecture, _Onion architecture_ and _Hexagonal_ (_Ports and adapters_) are similar to it.
 Both are based on the principle of Dependency Inversion.
 _Ports and adapters_ are very close to _Clean Architecture_, the differences are mainly in terminology.
 
-
 ## Similar projects
+
 - [https://github.com/bxcodec/go-clean-arch](https://github.com/bxcodec/go-clean-arch)
 - [https://github.com/zhashkevych/courses-backend](https://github.com/zhashkevych/courses-backend)
 
 ## Useful links
+
 - [The Clean Architecture article](https://blog.cleancoder.com/uncle-bob/2012/08/13/the-clean-architecture.html)
 - [Twelve factors](https://12factor.net/ru/)