Введение

Intro — это дополнение к приложениям на Rails, которое представляет новые функции и помогает пользователям ориентироваться в системе. Оно динамически внедряет скрипты Shepherd.js в приложение в зависимости от того, нужна ли пользователю помощь.

Функции Intro:

• управление пользовательскими турами в административном интерфейсе;
• поддержка многоязычности и загрузки изображений для контента туров;
• простота изменения стиля туров;
• совместимость с Turbolinks;
• удобство использования для не разработчиков.

Пример

Демонстрация

Demo Source

Установка

Добавьте intro в Gemfile:

gem 'intro'

Установите пакет:

$ bundle install

Сгенерируйте миграции и конфигурационные файлы:

$ rails generate intro:install

Мигрируйте базу данных:

$ rails db:migrate

Предварительно скомпилируйте ресурсы:

$ rails assets:precompile

Использование

Добавление ресурсов в представление

Включите intro_tags в общий макет перед закрытием тега body:

<%= intro_tags %>
</body>
</html>

intro_tags импортирует связанные с intro ресурсы и добавляет глобальную переменную _intro, которая хранит конфигурацию intro.

Примечание: если вы используете Turbolinks, чтобы обновить переменную _intro, intro_tags должен быть вставлен перед закрывающим тегом body.

Управление турами из административного интерфейса

Запустите приложение Rails и перейдите по адресу http://localhost:3000/intro/admin. В файле config/initializers/intro.rb вы можете найти учётные данные для входа в административный интерфейс.

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

Изменение стиля туров

Если вам не подходит стандартный стиль, вы можете сгенерировать файлы стилей с помощью команды:

$ rails generate intro:assets

Вы получите следующие файлы:

app/javascript/stylesheets/intro/_variables.scss
app/javascript/stylesheets/intro/custom.scss
app/javascript/packs/intro/custom.js

Измените их в соответствии со своими потребностями.

Наконец, включите настройку custom_assets в config/initializers/intro.rb:

# config/initializers/intro.rb

# override intro tour styles
self.custom_assets = true # or 'intro/custom'

Это приведёт к тому, что intro_tags будет ссылаться на ресурс intro/custom.

Конфигурация Intro

Подробности о конфигурации можно найти в файле config/initializers/intro.rb.

Благодарности

• shepherd
• abraham

Вклад

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

1. Создайте ветку для вашего изменения (git checkout -b my-new-feature).
2. Внесите свои изменения (git commit -am 'Add some feature').
3. Отправьте изменения в текущую ветку (git push origin my-new-feature).

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

Лицензия

Этот репозиторий можно использовать как открытый исходный код в соответствии с условиями лицензии MIT.