Cumulative loyalty system "Gophermart"

Система преднаначена для расчета бонусных начислений и ведения накопительного бонусного счета пользователя и состоит из следующих сервисов:

• Сервис расчета баллов лояльности
• Сервис начисления баллов лояльности

Для взаимодействия с сервисами предоставляется HTTP API.

Используемые технологии:

• PostgreSQL (в качестве хранилища данных)
• Docker (для запуска сервиса)
• Swagger (для документации API)
• Echo (веб фреймворк)
• golang-migrate/migrate (для миграций БД)
• pgx (драйвер для работы с PostgreSQL)
• golang/mock, testify (для тестирования)

Getting started

Для запуска системы необходимо создать файл .env, используя шаблон .env.example, и заполнить переменные своими значениями, исключая помеченные как DO NOT EDIT.

Usage

Запуск системы можно осуществить в форме docker-контейнеров с помощью команды make docker-run. Остановка системы осуществляется командой make docker-stop. Сервис расчета баллов лояльности после запуска будет доступен по адресу http://127.0.0.1:8080, Сервис начисления баллов лояльности - http://127.0.0.1:8081.

Альтернативой запуску контенеров является ручной запуск сервисов, подробнее об этом здесь и здесь.

Документацию по сервису начисления баллов лояльности после запуска можно посмотреть по адресу http://127.0.0.1:8081/swagger/index.html.

Веб-интерфейс pgAdmin4 доступен по адресу http://127.0.0.1:8082. Для авторизации в веб-интерфейсе используются следующие значения:

• Email Address/Username: значение PGADMIN_DEFAULT_EMAIL из файла .env
• Password: значение PGADMIN_DEFAULT_PASSWORD из файла .env

Для соединения с PostgreSQL посредством веб-интерфейса pgAdmin4 необходимо указать следующие параметры соединения:

• Имя/адрес сервера: postgres
• Порт: значение POSTGRES_PORT из файла .env
• Служебная база данных: postgres
• Имя пользователя: значение POSTGRES_USER из файла .env
• Пароль: значение POSTGRES_PASSWORD из файла .env

Данные сервиса будут располагаться в базе данных с именем POSTGRES_DB из файла .env.

Unit-тестирование можно провести посредством трёх команд:

1. make test - простое тестирование
2. make cover - тестирование с покрытием
3. make cover-html - тестирование в результате которого будет сгенерирован файл cover.html с подробным отчётом о покрытии

Запуск линтера осуществляется командой make lint.