Yet Another Delivery Backend

Содержание

1. Ссылки
2. Запуск
3. Схема БД
4. Структура проекта
5. Правила

Ссылки

📑 Доска задач

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

📱 Android

☎️ iOS

Запуск

Локальный запуск

Перед запуском необходимо установить локальные настройки БД в файле configs/config.yml, который генерируется из configs/config.yml.example командой make config

make run

Запуск с помощью Docker

make docker_build
make docker_run

1. Проверка:

http://localhost:9000/api/v1/ping

2. При первом запуске нужно выполнить скрипт schema/init.sql внутри контейнера с БД.

3. Доступные эндпоинты после запуска можно посмотреть по адресу:

http://localhost:9000/swagger/index.html

Схема БД

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

.
├── internal
│   ├── app          // инициализация проекта
│   ├── domain       // основные структуры
│   ├── delivery     // обработчики запросов
│   ├── service      // бизнес-логика
│   └── repository   // взаимодействие с БД
├── cmd              // точка входа в приложение
├── schema           // SQL файлы с миграциями
├── configs          // файлы конфигурации
├── docs             // документация
├── tests            // интеграционные тесты
└── .github          // файлы настройки Github Actions

Правила

Перед тем как коммитить изменения выполните make lint.

Ветки

Каждый новый тикет (issue) следует выполнять в отдельной ветке с префиксом fb-N-, где N - номер тикета. После в названии следует краткая информация о задаче.

Например, тикет #1 Проектирование БД, ветка fb-1-db-schema.

Коммиты

Коммиты в ветке должны начинаться с #N.

Пример для ветки выше - "#1 Update DB schema picture".

Запросы на слияние

После выполнения задания надо назначить Pull Request (PR) в ветку develop.

PR содержит название тикета, в описании указывается связь с ним.

Пример PR.