Создание модуля для Okapp
Содержание
В этой инструкции рассказывается про создание модуля для Okapp. Созданный модуль можно использовать как основу для дальнейшей разработки веб-приложений. Для генерация кода используется Yeoman-генератор модулей, специально подготовленный нашими разработчиками.
Код проекта вы можете просмотреть по ссылке https://github.com/telsystems/generator-oktell-module
Установка генератора модулей
1. Для начала работы требуется скачать и установить node.js. Для этого перейдите по ссылке http://nodejs.org/ и нажмите кнопку Install.
2. Установите Yeoman, Grunt, Bower и генератор модулей. Для этого в командной строке выполните команду
npm install -g grunt-cli bower yo generator-oktell-module
Генерация простейшего модуля
1. Создайте папку для модуля и запустить в ней генератор. Для этого в командной строке поочередно введите следующие команды:
mkdir ourModule cd ourModule yo oktell-module
2. Генератор попросит ввести идентификатор (название) для вашего модуля и адрес севера Oktell. В качестве сервера вы можете указать как IP-адрес, так и доменное имя. В примере введено название testmodule и ip-адрес 192.168.0.82.
ВНИМАНИЕ: Не рекомендуется использовать названия с дефисами.
После успешного выполнения команды вы получите рабочий код простейшего модуля в созданной папке, в примере \ourModule.
Отладка с помощью локального веб-сервера
Для удобства отладки вы можете запустить локальный веб-сервер, который проксирует Okapp с указанного сервера Oktell и передает ему необходимые данные. Выполните в командной строке:
grunt serve
В итоге, Okapp загружается с сервера Oktell, а все данные нашего разрабатываемого модуля из текущей папки. Список загружаемых скриптов и стилей, а также их порядок указан в файле manifest.json нашего модуля.
С помощью локального веб-сервера вы не сможете проверить выполнение SQL-запросов. Поэтому при наличии SQL-файлов, необходимо предварительно собрать модуль и установить через Магазин в Okapp.
Остановить локальный веб-сервер вы можете с помощью комбинации Ctrl+C в командной строке.
Сборка модуля
Чтобы получить сборку модуля, готовую к установке через Магазин в Okapp выполните в командной строке:
grunt build
После выполнения, архив доступен в папке dist директории с модулем. В примере — это папка \ourModule\dist.
Установка в веб-клиент
Установить созданное приложение в Okapp вы можете с помощью модуля "Магазин". Нажмите кнопку "Установить из файла" и выберите zip-архив из папки dist.
После успешной установки на экране всплывет уведомление, а в боковом меню появится соответствующий значок. Щелкнув по нему, вы попадете в установленный модуль.
Документация по созданию веб-модулей: https://github.com/telsystems/web-modules/wiki
Удачной разработки!
