diff --git a/architecture/golang/README.md b/architecture/golang/README.md index 1ff4946..0ce3ed2 100644 --- a/architecture/golang/README.md +++ b/architecture/golang/README.md @@ -14,23 +14,18 @@ ├── .dockerignore - Файл для перечисления игнорирования докером файлов/директорий ├── .gitignore - Файл для перечисления игнорирования гитом файлов/директорий ├── .gitlab-ci.yml - Файл настройки Gitlab CI -├── .golangci.yaml - Файл настройки линтера для Golang -- убрать, вынести в общий репозиторий, в хуки -├── .mockery.yaml - Файл настройки пакета mockery для генерации моков на Golang -- либо заменяем мокери, либо мок имиспользуем для внешних зависимостей или пустых сервисов -├── .buf.gen.yaml - https://buf.build/docs/configuration/v1/buf-gen-yaml -├── .buf.work.yaml - https://buf.build/docs/configuration/v1/buf-work-yaml/ -├── .buf.yaml - https://buf.build/docs/configuration/v1/buf-yaml/ -- proto2swagger не используем +├── .mockery.yaml - Файл настройки пакета mockery для генерации моков на Golang. используем для внешних зависимостей или пустых сервисов ├── go.mod - Корень управления зависимостями в GoLang ├── go.sum - Файл содержащий хеши для нескольких версий модуля -├── Makefile - Набор команд -- заменить на go-task +├── Taskfile.yml - Набор команд go-task ├── README.md - Общий файл документации (путеводитель) ``` ## Структура `/cmd`: ``` -├── [app name] - Название приложения (app) -- уходим от пракки некольких сервисов в одном репозитории, поэтому подкаталог делать не надо -│ ├── main.go - Точка входа в приложение -│ ├── Dockerfile - Файл контейнеризации сервиса -- проверить возможность скопировать из корня проекта +├── main.go - Точка входа в приложение +├── Dockerfile - Файл контейнеризации сервиса -- проверить возможность скопировать из корня проекта ``` ## Структура `/docs`: @@ -53,11 +48,10 @@ ├── adapters - Данная директория хранит адаптеры для взаимодействия с внешними сервисами │ ├── client - Пакет клиента для взаимодействия с другими приложениями (REST, gRPC) │ │ ├── [name].go - Сам клиент -├── repository - Директория репозиториев для взаимодействия с базой данных -- если есть набор отдельных баз, то делаем отдельные подкаталоги +├── repository - Директория репозиториев для взаимодействия с базой данных, если есть набор отдельных баз, то делаем отдельные подкаталоги │ ├── [name].go - Файл репозитория (user.go) ├── controller - Директория контроллеров │ ├── [name] - Директория контроллера -│ │ ├── mocks - Директория, которая хранит сгенерированные моки для контроллера │ │ ├── [name].go - Сам контроллер. Хранит в себе обработчики внешних запросов │ │ ├── [name]_test.go - Файл тестов для контроллера ├── models - Пакет моделей данных