Версия: 5.x
Общие сведения о Marketplace

Маркетплейс ReadyScript предлагает разработчикам размещение собственных дополнений. Опубликованные дополнения будут доступны для установки всем пользователям платформы ReadyScript через административную панель своего интернет-магазина или через отдельный сайт http://marketplace.readyscript.ru "Marketplace.ReadyScript.ru"

Технически, дополнение представляет из себя zip-архив, содержащий структуру файлов и папок соответствующих определенному типу дополнения. Дополнения делятся на следующие типы:

  • Модули
    Привносят определенную функциональность в систему. Например, это может быть: способ оплаты, доставки, печатный документ, интеграция с другими сервисами, визуальные блоки и т.д.
    Устнавливаются в папку модулей /modules
  • Темы оформления
    Привносят индивидуальное отображение интернет-магазина клиенту.
    Устанавливаются в папку с темами оформления /templates
  • Готовые решения
    Это может быть полностью завершенный интернет-магазин для какой-либо тематики. Технически представляет из себя тему оформления + модуль.
    Устанавливается в папку /modules и /templates

Разработчик может выпускать обновленные версии собственных дополнений, которые будут доставляться пользователям через единый центр обновления платформы. Пользователям облачной версии ReadyScript обновленные модули будут устанавливаться автоматически.

Разработчик вправе загрузить отдельный zip-архив с демо-версией дополнения. Характер ограничений, реализованных в демо-версии, полностью определяется разработчиком. Это может быть урезанная функциональность или ограниченный по времени период использования дополнения.

Условия размещения дополнений в Marketplace

Все дополнения, представленные в Marketplace проходят обязательную проверку модераторами. Дополнения, соответствующие всем требованиям, будут допущены к публикации. ReadyScript преъявляет высокие требования к качеству размещаемых дополнений:

  1. Код модуля должен быть оформлен и документирован в едином стиле оформления кода ReadyScript.
  2. Код модуля должен быть оптимальным и максимально использовать подходы и концепции предусмотренные платформой ReadyScript. (Например, код должен быть разделен, согласно концепции MVC; запросы к БД должны осуществляться через подсистему ORM; для формирования URL адресов должны использоваться Маршруты (route) и .т.д.)
  3. Опции и параметры модуля должны быть вынесены в настройки модуля и управляться через административную панель.
  4. Решение должно работать в режиме мультисайтовости.
  5. Модуль должен работать корректно на всех заявленных комплектациях платформы ReadyScript во всех случаях и при всех возможных сочетаниях входящих данных.
  6. Модуль не должен содержать ошибок JavaScript, предупреждений PHP.
  7. Модуль должен иметь достаточный набор возможностей для решения поставленной задачи.
  8. Желательно включение в модуль демонстрационных данных.
  9. Карточка дополнения в Marketplace ReadyScript должна быть полностью заполнена, качественно описаны разделы «Описание», «Установка», «Поддержка» и др.
  10. Дополнение не должно нарушать законодательство РФ.
  11. Дополнение не должно содержать вредоносный код.

Порядок разработки дополнений

При проектировании формата дополнений ReadyScript, мы стремились сделать разработку, тестирование и подготовку дополнений максимально простой. Предлагаем использовать следующий порядок при разработке дополнений:

  1. Установите интернет-магазин ReadyScript на локальный компьютер в любом LAMP окружении.
    Если дополнение должно работать на нескольких комплектациях платформы ReadyScript, то необходимо установить наименее функциональную комплектацию.(например, если дополнение планируется для использования на ReadyScript.Витрина и ReadyScript.Маркет, то необходимо устанавливать ReadyScript.Витрина)
  2. Разработайте модуль, тему оформления или решение.
  3. Протестируйте на локальной копии:
    • установку модуля
    • удаление модуля (будьте внимательны, при удалении модуля все его файлы удаляются, обязательно создайте копию модуля предварительно)
  4. Упакуйте в zip-архив папку с модулем, темой оформления или решением. Полученный архив и есть - дистрибутив дополнения.
  5. Разместите дополнение в Marketplace ReadyScript.

Ядро ReadyScript предоставляет механизм обновления модулей "по-умолчанию", благодаря чему разработчик может просто вносить изменения в свой модуль, менять состав полей в ORM объектах, и загружать очередную версию дистрибутива дополнения в маркетплейс. Механизм обновления ReadyScript "по-умолчанию" автоматически приведет базу данных клиента в актуальное состояние и заменит все файлы новыми версиями.

Если в модуле переопределен стандартный механизм установки и обновления дополнения, то разработчик должен дополнительно тестировать работоспособность механизма обновления.

Если необходимо протестировать модуль непосредственно на доступном из Интернета сайте (например, если вы разрабатываете модуль оплаты и нужна проверка входящих запросов от банка), создайте аккаунт в облаке ReadyScript и установите на него ваш модуль. Даже не прошедшие модерацию модули могут быть установлены на собственные аккаунты разработчика в облаке. Чтобы установка дополнения в магазин разработчика в облаке была доступна, убедитесь что в карточке дополнения в поле Продукт отмечен флажок "облако", а в поле Комплектация указана используемая разработчиком в облаке комплектация платформы ReadyScript.