MRS-Toolbox Extension

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

1. Установите расширение
2. Создайте git-репозиторий
3. Чтобы иметь возможность запускать тесты, установите Node JS версии 14.18.1 или выше с npm версии 6.14.15 или выше.
4. Создайте папку для вашего проекта
5. Нажмите на кнопку «Prepare workspace with needed files» или «Подготовить стартовое рабочее окружение», чтобы создать базовую структуру проекта.
6. Настройте конфигурацию в файле mrsconfig.json

7. Сохраните изменения в develop-ветку для выкладки на dev-сервер или в master-ветку для выкладки на prod-сервер

Для более детальной информации ознакомьтесь с документацией.

Запуск тестов

1. Нажмите на кнопку «Run hook tests» или «Запустить тесты хуков», чтобы создать папку tests c демо-тестом.
2. Если необходимо, установите необходимые npm-пакеты в папку tests.
3. Напишите свои тесты и ещё раз нажмите на кнопку «Run hook tests» или «Запустить тесты хуков», чтобы запустить тесты. Результаты тестов отобразятся в секции Output.

Загрузка экспортной конфигурации на S3

1. Нажмите на кнопку «Export config in json» или «Создать экспортную конфигурацию», чтобы создать экспортную конфигурацию.
2. Экспортная конфигурация появится в папке ./.out
   1. Помимо экспортной конфигурации, в зависимости от данных, экспортируются и другие объекты
   2. При наличии файла manifest.json он так же попадает в ./.out
   3. При наличии dictionaries будет создана папка ./.out/dictionaries с экспортированными items и snapshot
   4. При наличии dashboards будут созданы архивы (в ./.out) для импорта в superset, имя которых совпадает с названием папки в которой они находятся
   5. При наличии functions будет создан файл ./.out/triggers.json с триггерами функций и внутри папки ./.out/functions будут собранные облачные функции
3. Нажмите на кнопку «Upload export config and templates to s3» или «Загрузить экспортную конфигурацию с шаблонами на S3», чтобы загрузить экспортную конфигурацию в хранилище.

Очистка окружения

1. Нажмите на кнопку «Clear workspace for new config» или «Очистить окружение», чтобы очистить окружение

Note: Вы удалите все свои исходники из папки src.

Авторизация в Directus

Note: Кнопка будет активна только тогда, когда вы не авторизованы в Directus.

1. Нажмите на кнопку «Auth to directus» или «Авторизация в директус», чтобы авторизироваться в Directus.

Note: Перед тем как авторизироваться убедитесь что вы удалили строчку token в файле конфигурации mrscconfig.json 2. Введите ваш Email и пароль. 3. При успешном входе вы увидите уведомление "You have been logged successfully!" или "Вы успешно вошли в систему"

Деавторизация в Directus

Note: Кнопка будет активна только тогда, когда вы уже авторизованы в Directus.

1. Нажмите на кнопку «Unauthorization from directus» или «Выйти из директуса», чтобы деавторизироваться в Directus.
2. При успешной деавторизации вы увидите уведомление "Logout successfully!" или "Выход успешно завершен!"

Выгрузка из Directus

Note: Кнопка будет активна только тогда, когда вы авторизованы в Directus.

1. Нажмите на кнопку «Pull dictionaries from directus» или «Выгрузка из директуса», чтобы выгрузить справочники в src/dictionaries.
2. При успешной выгрузке вы увидите уведомление "Data is successfully pulled!!" или "Данные успешно загружены!!"
3. При выгрузке создается папка dictionaries внутри которой содержатся подпапки с именем справочников (например ./src/dictionaries/testDictionary)
   1. Каждая такая папка содержит два файла: fields.json и items.json
   2. Fields.json - это поля с их типом, названием и свойствами
   3. Items.json - конкретные данные

Superset

1. Dashboards должны располагаться в папке ./src/dashboards/superset
2. Каждый дэшборд находится в папке с его именем (например ./src/dashboards/superset/test) , внутри которой находится структура дэшбордов

• charts
  • *.yaml
• dashboards
  • *.yaml
• datasets
  • *.yaml
• databases
  • *.yaml
• metadata.yaml

Cloud functions

1. При создании внутри папки ./src/functions любой другой папки происходит инициализация облачной функции

   Note: Имя папки может содержать только символы латинского алфавита и знак "-"

2. Создаются папки dist, node_modules, src и test
   1. dist - содержит в себе собранный исходник функции из src
   2. node_modules - модули для работы тестов и самой облачной функции
   3. src - содержит исходник функции
   4. test - содержит в себе тесты для функции
3. Также создаются файлы .eslintrc.json, package.json и webpack.config.js
   1. .eslintrc.json - конфигурация для линтера функции
   2. package.json - туда необходимо прописывать триггеры в functionsParameters и добавлять зависимости в dependencies
   3. webpack.config.js - конфигурация для сборщика webpack

Обратная связь

Если вы столкнулись с какими-то проблемами или у вас есть предложения по улучшению плагина напишите на почту support@mrsapp.ru.