@retailrocketgroup/smart-search

Руководство для разработчиков

Это руководство описывает шаги, необходимые для настройки проекта для нового партнера.

1. Настройка переменных в GitLab CI/CD

Перейдите в Settings → CI/CD → Variables вашего репозитория в GitLab и создайте переменную NETLIFY_SITE_ID.

Важно: Для переменной NETLIFY_SITE_ID убедитесь, что опция "Protect variable" отключена.

2. Настройка локального файла окружения

В корне проекта уже существует файл .env с пустыми переменными. Заполните их значениями, если они у вас есть.

Пример:

VITE_PARTNER_ID=67a36d174c1c149184af4142
VITE_PARTNER_STOCK=
VITE_PARTNER_LANG=en

3. Проверка API Endpoint

В файле .env проверьте значение VITE_RETAIL_ROCKET_SEARCH_API.

• Для иностранных партнеров домен должен заканчиваться на .net.
• Для российских партнеров домен должен заканчиваться на .ru.

4. Настройка пути для CDN

В файле .gitlab-ci.yml найдите переменную S3_PARTNER_FOLDER и установите ее значение равным ID партнера.

Пример:

variables:
  S3_PARTNER_FOLDER: "67a36d174c1c149184af4142"

5. Обновление информации о пакете

В файле package.json измените следующие поля:

• name: Измените его в соответствии с форматом @retailrocketgroup/smart-search-<partnerId>.
• version: Сбросьте его на "0.0.0".

Пример:

{
  "name": "@retailrocketgroup/smart-search-67a36d174c1c149184af4142",
  "version": "0.0.0"
}

6. Очистка Changelog

Перед началом разработки для нового партнера очистите все содержимое файла CHANGELOG.md.