primo explore devenv
December 2022
Каталог gulp : содержит различные сценарии сборки для среды и файл конфигурации config.js , в котором должен быть определен ваш целевой прокси-сервер.
Каталог node_modules : содержит различные сторонние модули, необходимые для запуска системы. Эти модули определены в файле package.json .
Каталог пакетов : как только ваш пакет разработки будет готов, вы сможете собрать его с помощью команды gulp create-package , которая создаст заархивированный файл пакета, который вы определите в этой папке.
Каталог primo-explore : состоит из 2 каталогов:
Пакет разработки позволяет настроить следующие компоненты страницы (подробнее перейдите по ссылкам):
CSS
HTML
Изображения
JavaScript
Для каждого типа конфигурации или для каждого отдельного представления Primo должна быть указанная папка с именем представления (которая соответствует установленной структуре каталогов) в папке пакета primo-explore/custom .
Эту пользовательскую папку View можно загрузить из вашего бэк-офиса Primo, выбрав Primo Home > Primo Utilities > UI customization Package Manager , или начать заново из репозитория primo-explore-package GitHub. (Преимущество использования этого репозитория состоит в том, что в каждой папке вы найдете определенный файл README.md, содержащий рецепты и примеры.)
Примечание. Если вы не являетесь администратором своего компьютера, у вас могут возникнуть проблемы, описанные ниже. Мы рекомендуем использовать «Командную строку Node.js (найдите cmd на вашем компьютере, чтобы найти ее) всякий раз, когда приведенные ниже инструкции относятся к « командная строка».
Загрузите проект из этого репозитория и разместите его на своем компьютере.
Разархивируйте загруженный файл в нужную папку проекта разработки.
Загрузите и установите версию Node 16.17.0.
Перезагрузите компьютер
В командной строке выполните команду: npm install -g gulp
В новом окне командной строки перейдите в базовый каталог проекта ( cd pathtoyourprojectfolderprimo-explore-devenv ).
Из командной строки выполните команду: npm install (при этом должны быть установлены все модули узла, необходимые для gulp.)
Отредактируйте настройки прокси-сервера файла конфигурации Gulp, расположенные по адресу gulp/config.js : var PROXY_SERVER = http://your-server:your-port (обязательно используйте реальный URL-адрес внешнего интерфейса Sandbox или Production Primo.) Обратите внимание, что для Среды SSL (HTTPS) определяют сервер как: var PROXY_SERVER = https://your-server:443
Заполните папку пользовательского пакета View в папке пользовательского пакета («...primo-explorecustom»), загрузив файлы кода представления из бэк-офиса Primo или используя репозиторий primo-explore-package GitHub), чтобы запустить новая папка пакета. (если вы уже определили пакет представления и загрузили его в BO — обязательно загрузите его, иначе вы не увидите и можете перезаписать свои предыдущие изменения.)
Если ваша папка пакета пользовательского представления должна называться «Auto1», тогда дерево каталогов вашей среды разработки должно выглядеть примерно так: 
ВАЖНО: Имя папки пакета пользовательского представления должно совпадать с существующим представлением на прокси-сервере, на который ссылаются, иначе сервер Gulp не будет работать должным образом. При разработке с нуля обязательно сначала создайте (или скопируйте) представление с помощью мастера представлений Primo Back Office; затем вы сможете выполнить настройку локально, используя этот документ.
Начните настройку кода:
В командной строке выполните команду: gulp run --view <the VIEW_CODE folder> (это запустит ваш локальный сервер.)
(Например, запуск gulp run --view Auto1 запустит среду, берущую настройки из папки Auto1 .)
Для клиентов Primo VE добавьте флаг --ve: gulp run --view <the VIEW_CODE folder> --ve
Откройте браузер и введите следующий URL-адрес: localhost:8003/primo-explore/?vid=your-view-code (пример: http://localhost:8003/primo-explore/search?vid=Auto1).
Для клиентов Primo VE откройте следующий URL-адрес: localhost:8003/discovery/?vid=your-institution-code:your-view-code
Теперь вы сможете выполнять свои настройки с помощью реальных поисков и результатов с ранее определенного прокси-сервера. Примечание: как только вы начнете работать с этой средой, вы обнаружите, что наилучшие результаты достигаются при работе в режиме инкогнито вашего браузера; или вы можете очистить кеш браузера перед запуском сервера Gulp.
Вы можете получить немедленную обратную связь об изменениях кода, обновив браузер.
Внесите изменения в соответствии с документацией/примерами:
CSS
HTML
Изображения
JavaScript
Примечание. У вас есть несколько вариантов редактирования файла CSS (custom1.css) и файла js (custom.js), некоторые из них включают методы разделения ваших разработок на отдельные файлы. При использовании таких методов файлы custom1.css и custom.js будут переопределяться другими файлами при запуске gulp. Поместите свои собственные CSS и JS в файлы с разными именами, например custommodule.css или custom.module.js, чтобы объединить их в пользовательские файлы css/js.
Завершив настройку пакета, вы можете заархивировать этот каталог и загрузить его с помощью Primo BackOffice.
В окне командной строки перейдите в базовый каталог проекта: cd pathtoyourprojectfolderprimo-explore-devenv
В командной строке выполните команду: gulp create-package Вам будет предложено меню с указанием всех возможных пакетов, которые вы можете собрать, например:
Войдите в Primo Back Office и перейдите в раздел «Диспетчер пакетов настройки пользовательского интерфейса» : Primo Home > Primo Utilities > UI customization Package Manager
Используйте кнопку обзора файлов, чтобы найти и загрузить новый файл заархивированного пакета. (Находится в каталоге «pathtoyourprojectfolderprimo-explore-devenvpackage».)
Не забудьте развернуть изменения
Как только вы закончите настройку пакета, вы сможете подготовить его к публикации в Primo-Studio.
В окне командной строки перейдите в базовый каталог проекта: cd pathtoyourprojectfolderprimo-explore-devenv
В командной строке выполните команду: gulp prepare-addon Вам будет предложено меню с указанием всех возможных пакетов, которые вы можете собрать.
После завершения запуска сценария в папке pathtoyourprojectfolderprimo-explore-devenvaddons будет создана папка, содержащая надстройку.
Из указанной выше папки вы можете опубликовать свое дополнение в NPM и Primo-Studio. Инструкции см. в: Учебное пособие по дополнению Primo-Studio.
