ZergsLaw / back-template

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Документация проекта

Введение

Данный документ содержит описание основных команд проекта, используемых через файл задач (taskfile). Каждая команда представляет собой задачу, выполняемую в контексте разработки микросервисной архитектуры, включая тестирование, сборку, генерацию сертификатов и запуск сервисов.

Структура проекта

Проект содержит два микросервиса:

  • user - микросервис пользователя.
  • session - микросервис сессий.

Конфигурационные файлы для каждого микросервиса находятся в их соответствующих директориях. Однако часть конфигурации может быть изменена через переменные окружения (энвы).

Используемые команды

task test-unit

Запускает модульное тестирование с использованием инструментария gotestsum. Тесты выполняются с параметрами проверки гонок и покрытия кода.

task test-integration

Выполняет интеграционное тестирование с использованием тех же инструментов, что и модульное тестирование, но с дополнительными тегами для интеграции.

task build

Собирает проект, используя скрипт build.sh.

task generate_certs

Генерирует сертификаты, необходимые для безопасного соединения между сервисами, используя образ cockroachdb.

task init

Инициализирует окружение проекта, устанавливает зависимости и генерирует сертификаты.

task lint

Запускает линтеры для проверки качества кода.

task up

Запускает сервисы в докере с использованием Docker Compose.

task down

Останавливает и удаляет контейнеры, сети, тома и образы, созданные командой up.

Команды

Описанные команды предназначены для упрощения процесса разработки и обеспечения единообразия окружения всех разработчиков. Используйте их в соответствии с текущими потребностями разработки.

About

License:MIT License


Languages

Language:Go 98.2%Language:Shell 1.7%Language:Dockerfile 0.2%