Gulp and InSales uploader

InSales uploader позволяет локально работать с темами платформы InSales

Содержимое gulpfile.js

// Подключение библиотек
var gulp = require('gulp');
var insalesUp = require('insales-uploader');

// Настройки для InSales uploader
var options = {
  account: {
    id: '0123456798',
    token: '0123456798',
    url: 'shop-41324.myinsales.ru',
    http: false
  },
  theme: {
    id: '123456',
    root: 'my-shop',
    update: true,
    startBackup: true
  }
}

// Инициализация InSales uploader
var InsalesUploader = new insalesUp(options)

// Пример задачи для скачивания темы.
gulp.task('download', function(){
  return InsalesUploader.download()
});

// Задача запускает создание резервной копии с созданием архива.
gulp.task('backup', function(){
  return InsalesUploader.backup()
});

// Задача запускает отслеживание изменений в файлах.
gulp.task('stream', function(){
  return InsalesUploader.stream()
});

// Задача запускает сортировку аcсетов из папки media в папку assets
gulp.task('init-assets', function(){
  return InsalesUploader.initAssets()
});

// Задача запускает сравнивание списка файлов на сервере со списком в локальной копии
gulp.task('diff-assets', function(){
  return InsalesUploader.diffLocalAssets()
});

// Пример задачи поумолчанию, сначала запускается скачивание, после чего запускаем отслеживание изменений.
gulp.task('default', ['download'], function() {
  return gulp.start('stream');
});

Как начать работать

• Если у вас не установлен node.js, то необходимо установить с оф. сайта, желательно последнюю версию.
• Скачать архив данного репозитория или сделать git clone.
• Установить пакеты через npm.
• Отредактировать options в gulpfile.js в соответствии с вашим магазином.
• Запустить нужную задачу.
• Переодически следить за обновлением пакета InSales uploader (чтобы обновить пакет, в консоли нужно запустить npm update).

Видео по установке

• Создание ключа доступа
• Установка npm пакетов
• Добавление настроек

Установить пакеты через npm

Установка пакетов производится из командной строки (должен быть установлен node.js).

В командной строке находим папку в которую вы скопировали данный репозиторий.

Пример:

cd c:\shop-insales

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

После того как вы открыли папку, можно запустить установку пакетов:

npm install

Options

account

• id, token — необходимо сгенерировать в бэк-офисе: Приложения -> Разработчикам -> Создать новый ключ доступа;
• url — url магазина из бэк-офиса, ссылка не должна содержать 'http://' и '/';
• http — если в админ панели нет поддержки https, следует выставить значение - true;

theme

• id — id темы;
• root — корнеевая папка для сохранения темы;
• update — при значении 'true' локальные файлы будут перезаписываться при повторной загрузке;
• startBackup — при значении 'true' во время загрузки темы через метод download в папке 'backup' будут сохранятся резервные копии темы.

Запуск задач

Чтобы запустить задачу, в командной строке нужно запустить:

gulp <имя задачи>

Пример:

gulp download

Задача с именем default запускается просто:

gulp

После того как запустится задача с методом stream, все изменения в файлах будут применяться на сайте.

Структура папок

root/
    |-- assets/
        |-- fonts/
        |-- img/
        |-- js/
        |-- media/
        |-- style/
        |-- svg/
    |-- config/
    |-- media/
    |-- snippets/
    |-- templates/
    |-- backup/

Возможные ошибки (ждут исправления)

• Ошибка при создании сниппета. Сниппет создастся, но платформа может выдать ошибку.
• Не скачивается пустой settings.html.

О проблемах в работе пишите сюда

Ссылки

Node.js

• Дистрибутив Node.js

Gulp

• Сайт Gulp.js
• Базовый курс по Gulp
• Сринкаст по Gulp