lookbook

Среда разработки пользовательского интерфейса для приложений Ruby on Rails.

Документация | Демо-сайт

Lookbook сочетает в себе мощный браузер компонентов и систему предварительного просмотра со встроенным механизмом документации, помогая командам создавать надежные, модульные и удобные в обслуживании пользовательские интерфейсы.
Он совместим с партиалами ViewComponent, Phlex, ActionView и другими.
Читать документацию →

---

Разработка

Lookbook реализован как изолированный движок Rails и использует ViewComponent, Tailwind и Alpine для своего пользовательского интерфейса.

Этот репозиторий содержит:

• Исходный код Lookbook ( /app , /lib , /config и т. д.)

• Исходный код и содержимое сайта документации Lookbook ( /docs ).

• Набор тестов с «запускаемым» фиктивным приложением ( /spec ).

Сайт документации

Сайт документации Lookbook создан с использованием Bridgetown, а исходные файлы можно найти в каталоге ./docs .

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

1. Клонировать этот репозиторий

2. Установить зависимости: bundle install

3. Запустите приложение: bin/docs

4. Посетите http://localhost:4000.

Тестирование

Lookbook использует RSpec для тестирования.

Тесты можно запускать с помощью команд rake spec или bundle exec rspec .

Фиктивное приложение, для которого выполняются тесты, можно просмотреть, запустив команду bin/dummy и затем перейдя по адресу http://localhost:9292/lookbook.

Релизы

Lookbook использует Release It! автоматизировать процесс выпуска.

Запуск npm run release запустит процесс публикации нового выпуска и пройдет все этапы: от выбора номера версии до публикации обновленного драгоценного камня.

Для публикации выпуска требуются разрешения на запись для этого репозитория (lookbook-hq/lookbook) и разрешения на публикацию 2FA для Lookbook на RubyGems.

Содействие

Lookbook — это нефинансируемый проект с открытым исходным кодом, и вклад всех типов и размеров приветствуется!

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

Авторы

Lookbook был создан Марком Перкинсом и продолжает расти и совершенствоваться благодаря идеям, предложениям и упорному труду всех этих замечательных людей:

Лицензия

Гем доступен с открытым исходным кодом в соответствии с условиями лицензии MIT.