Руководство по установке#

В данном руководстве приведена инструкция по установке компонента Библиотека визуальных компонентов UFSUI (UIUF) продукта Platform V UI Kits (UIK).

Список терминов и определений, используемых в данном руководстве, приведен в одноименном разделе документа «Детальная архитектура».

Системные требования#

Организация окружения#

Для установки, настройки и успешной эксплуатации приложения требуется наличие следующего программного обеспечения:

Название

Версия

Описание

Альт СП

8

Операционная система — рекомендуемое ПО

MacOC Monterey

12.4

Операционная система — альтернативное ПО

Node.js

16.17.0

Серверная платформа для работы с JavaScript

Yarn

1.22.19

Альтернативный npm-клиент для работы в качестве пакетного менеджера JavaScript

Кроме того, необходимо соблюдение следующих условий:

  • настроенный файл конфигурации .npmrc, используемый npm в соответствии с npm-registry;

  • наличие учетной записи в npm-registry с правами на чтение.

Для публикации пакетов библиотеки сконфигурируйте файл .npmrc, как показано в примере ниже:

email=<адрес УЗ>
registry=<необходимый npm-registry>
@v-uik:registry=<адрес npm-registry>
strict-ssl=false
always-auth=true
_auth=<авторизационный токен УЗ>

Установка#

Публикация npm пакетов в npm-registry#

  1. Распакуйте zip-архив дистрибутива любым архиватором, используемым в ОС.

  2. Для каждого файла npm-пакета (\*.tgz) примените команду: npm publish <filename> в консоли ОС.

Для публикации всех пакетов используйте команду: for file in *.tgz; do npm publish "$file"; done.

Установка пакетов библиотеки в прикладном проекте#

  1. Перейдите в каталог прикладного проекта.

  2. Выполните команду npm install <имя пакета> (например npm install @v-uik/button).

Обновление#

Обновление представляет собой распаковку zip-архива новой версии релиза, как указано в разделе «Установка».

Удаление#

Чтобы удалить npm-пакет из проекта, используйте команду:

$ npm unpublish <имя пакета>.

Так как в качестве хранилища дистрибутива используется Nexus – интегрированная платформа, с помощью которой разработчики могут проксировать, хранить и управлять зависимостями Java, то удалить пакет можно также в его web-интерфейсе:

  1. Выберите пакет для удаления.

  2. Нажмите кнопку «Delete».

Проверка работоспособности#

При успешной установке пакета в командной строке ОС будет отображаться следующая информация:

~/Projects/my-app(master*) » npm install @v-uik/<package-name>
+ @v-uik/<package-name>@1.3.0
 added 1 package from 1 contributor in 6.205s

Также проверить корректность публикации npm-пакетов библиотеки в npm-registry можно с помощью команды npm info.

Пример: npm info @v-uik/common@0.4.0, где common - наименование пакета, @0.4.0 - версия пакета.

Откат#

Откат технологически не предусмотрен. Пользователь имеет доступ ко всем ранее установленным версиям.

Часто встречающиеся проблемы и пути их устранения#

Для текущей версии компонента известных проблем нет.

Чек-лист валидации установки#

  1. Проверить, что установка завершилась успешно: в командной строке ОС отсутствуют уведомления об ошибках.

  2. Проверить, в папке node_modules проекта появился соответствующий каталог @v-uik/<название компонента>.