go-components

module
v0.7.5 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 6, 2024 License: Apache-2.0

README

Описание GoComponents v0.7.5

Этот репозиторий содержит описание библиотеки GoComponents.

Статус библиотеки

Библиотека находится в стадии разработки.

Описание библиотеки

Библиотека содержит набор компонентов повторного использования:

  • компонент для доступа к произвольным настройкам: чтение, запись, а также с использованием кэша;
  • компонент упорядочивания записей на основе двусвязного списка, позволяет встраиваться в произвольные таблицы БД;

Подключение библиотеки

go get -u github.com/mondegor/go-components@v0.7.5

Установка библиотеки для её локальной разработки

  • Выбрать рабочую директорию, где должна быть расположена библиотека
  • mkdir go-components && cd go-components // создать и перейти в директорию проекта
  • git clone git@github.com:mondegor/go-components.git .
  • cp .env.dist .env
Консольные команды используемые при разработке библиотеки

Перед запуском консольных скриптов сервиса необходимо скачать и установить утилиту Mrcmd.
Инструкция по её установке находится здесь

  • mrcmd go help - выводит список всех доступных go команд (docker версия);
  • mrcmd go-dev help // выводит список всех доступных go-dev команд (локальная версия);
  • mrcmd go-dev fmt // исправляет форматирование кода (gofumpt -l -w -extra ./)
  • mrcmd go-dev goimports-fix // исправление imports, если это требуется (goimports -d -local ${GO_DEV_LOCAL_PACKAGE} ./)
  • mrcmd go-dev check // статический анализ кода библиотеки (линтеры: govet, staticcheck, errcheck)
  • mrcmd go-dev test // запуск тестов библиотеки
  • mrcmd golangci-lint check // запуск линтеров для проверки кода (на основе .golangci.yaml)
  • mrcmd plantuml build-all // генерирует файлы изображений из .puml подробнее

Примеры архитектуры системы с использованием библиотеки go-components

Пакет mrsettings

image

Подсистема планировки задач

image

Сервис использующий пакет mrsettings

image

Верхнеуровневая архитектура

image)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL