Skip to content

Latest commit

 

History

History
105 lines (64 loc) · 3.83 KB

README.md

File metadata and controls

105 lines (64 loc) · 3.83 KB

Бэкенд веб-приложения SOS-Котопес

Этот репозиторий содержит бэкенд для веб-приложения SOS-Котопес. Бэкенд построен с использованием Go и предоставляет RESTful API для взаимодействия с системой

Список задач

Следующие задачи ожидают выполнения для завершения разработки бэкенда:

  • Логгер

  • Заменить стандартный логгер Fiber на пользовательскую реализацию.

  • CI (Непрерывная интеграция)

  • Настроить CI pipeline для автоматизации тестирования, сборки и развертывания.

  • Docker Compose

  • Файл docker-compose.yml для оркестрации приложения и его зависимостей с использованием Docker.

  • Лицензия

  • Файл LICENSE для указания условий лицензирования проекта.

  • README

  • Написать подробный файл README.

  • Автоматические миграции базы данных

  • Реализовать автоматические миграции базы данных.

  • Документация Swagger

  • Выбрать библиотеку для автоматической генерации Swagger API, добавить аннотации для обработчиков.

Начало работы

Предварительные требования

  • Go 1.22.5+
  • PostgreSQL
  • Docker (опционально, для развертывания в контейнерах)

Установка

  1. Клонируйте репозиторий:

    git clone https://github.com/kotopesp/sos-kotopes.git
cd sos-kotopes/backend

  2. Установите зависимости:

    go mod tidy

Запуск приложения

Для запуска приложения выполните команду:

make run

примечание: Для выполнения команды PG_URL в Makefile должен быть обновлен.

Запуск через Docker Compose

Заполните docker-compose.yml файл (пока не поддерживается) и выполните команду:

docker-compose up --build

Миграции базы данных

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

make migrate-up

примечание: Для выполнения команды PG_URL в Makefile должен быть обновлен.

Практики разработки

Добавление зависимостей

При добавлении новых зависимостей в проект:

  1. Добавьте вашу зависимость в файл go.mod используя команду go get или напрямую редактируя go.mod.
  2. Выполните команду go mod vendor .

Проверка качества кода

Для поддержки качества кода, придерживайтесь данных практик:

  • Выполняйте команду make lint перед коммитами или отправкой Pull Request'ов чтобы убедиться в том, что ваш код соответствует стандартам линтера.

Благодарности