lookbook

Eine UI-Entwicklungsumgebung für Ruby on Rails-Anwendungen.

Dokumentation | Demo-Site

Lookbook kombiniert einen leistungsstarken Komponentenbrowser und ein Vorschausystem mit einer integrierten Dokumentations-Engine, um Teams beim Aufbau robuster, modularer und wartbarer Benutzeroberflächen zu unterstützen.
Es ist kompatibel mit ViewComponent, Phlex, ActionView Partials und mehr.
Lesen Sie die Dokumente →

---

Entwicklung

Lookbook ist als isolierte Rails-Engine implementiert und verwendet ViewComponent, Tailwind und Alpine für seine Benutzeroberfläche.

Dieses Repository enthält:

• Der Lookbook-Quellcode ( /app , /lib , /config usw.)

• Der Quellcode und Inhalt der Lookbook-Dokumentationsseite ( /docs ).

• Eine Testsuite mit einer „ausführbaren“ Dummy-App ( /spec ).

Dokumentationsseite

Die Lookbook-Dokumentenseite wurde mit Bridgetown erstellt und die Quelldateien befinden sich im Verzeichnis ./docs .

Um eine lokale Vorschau der Änderungen anzuzeigen, können Sie eine Entwicklungsversion der Dokumentationsseite ausführen:

1. Klonen Sie dieses Repo

2. Abhängigkeiten installieren: bundle install

3. Starten Sie die App: bin/docs

4. Besuchen Sie http://localhost:4000

Testen

Lookbook verwendet RSpec zum Testen.

Tests können mit den Befehlen rake spec oder bundle exec rspec ausgeführt werden.

Die Dummy-App, für die die Tests ausgeführt werden, kann angezeigt werden, indem Sie den Befehl bin/dummy ausführen und dann zu http://localhost:9292/lookbook navigieren

Veröffentlichungen

Lookbook verwendet Release It! um den Freigabeprozess zu automatisieren.

Durch Ausführen von npm run release wird der Prozess der Veröffentlichung einer neuen Version gestartet und alle Schritte durchlaufen, von der Auswahl einer Versionsnummer bis zur Veröffentlichung des aktualisierten Gems.

Für die Veröffentlichung einer Veröffentlichung sind Schreibberechtigungen für dieses Repository (lookbook-hq/lookbook) und 2FA-Veröffentlichungsberechtigungen für Lookbook auf RubyGems erforderlich.

Mitwirken

Lookbook ist ein nicht finanziertes Open-Source-Projekt und Beiträge aller Art und Größe sind herzlich willkommen!

Bitte nehmen Sie sich die Zeit, den Beitragsleitfaden durchzulesen, bevor Sie Ihren ersten Beitrag leisten. Wenn etwas nicht klar ist, beginnen Sie eine Diskussion und wir werden unser Bestes tun, um Ihnen zu helfen.

Mitwirkende

Lookbook wurde von Mark Perkins erstellt und wächst und verbessert sich dank der Ideen, Vorschläge und der harten Arbeit all dieser hervorragenden Menschen weiter:

Lizenz

Das Juwel ist als Open Source unter den Bedingungen der MIT-Lizenz verfügbar.