README
¶
Документация проекта
Введение
Данный документ содержит описание основных команд проекта, используемых через файл задач (taskfile). Каждая команда
представляет собой задачу, выполняемую в контексте разработки микросервисной архитектуры, включая тестирование, сборку,
генерацию сертификатов и запуск сервисов.
Используемые команды
task test-unit
Запускает модульное тестирование с использованием инструментария gotestsum. Тесты выполняются с параметрами проверки
гонок и покрытия кода.
task test-integration
Выполняет интеграционное тестирование с использованием тех же инструментов, что и модульное тестирование, но с дополнительными тегами для интеграции.
task build
Собирает проект, используя скрипт build.sh.
task init
Инициализирует окружение проекта, устанавливает зависимости и генерирует сертификаты.
task lint
Запускает линтеры для проверки качества кода.
task up
Запускает сервисы в докере с использованием Docker Compose.
task down
Останавливает и удаляет контейнеры, сети, тома и образы, созданные командой up.
Команды
Описанные команды предназначены для упрощения процесса разработки и обеспечения единообразия окружения всех разработчиков. Используйте их в соответствии с текущими потребностями разработки.# back-template-monolite
Directories
¶
| Path | Synopsis |
|---|---|
|
api
|
|
|
user/v1
Package pb is a reverse proxy.
|
Package pb is a reverse proxy. |
|
cmd
|
|
|
back/internal/adapters/repo
Package repo contains wrapper for database abstraction.
|
Package repo contains wrapper for database abstraction. |
|
back/internal/api/grpc
Package grpc contains all methods for working grpc server.
|
Package grpc contains all methods for working grpc server. |
|
back/internal/api/http
Package http contains all methods for working http server.
|
Package http contains all methods for working http server. |
|
back/internal/app
Package app contains business logic.
|
Package app contains business logic. |
|
back/internal/auth
Package auth contains methods for working with authorization tokens, their generation and parsing.
|
Package auth contains methods for working with authorization tokens, their generation and parsing. |
|
internal
|
|
|
password
Package password will hash and comparable hash-pass.
|
Package password will hash and comparable hash-pass. |