Un environnement de développement d'interface utilisateur pour les applications Ruby on Rails.
Documents | Site de démonstration
Lookbook combine un puissant navigateur de composants et un système de prévisualisation avec un moteur de documentation intégré pour aider les équipes à créer des interfaces utilisateur robustes, modulaires et maintenables.
Il est compatible avec les partiels ViewComponent, Phlex, ActionView et plus encore.
Lire la documentation →
Lookbook est implémenté en tant que moteur Rails isolé et utilise ViewComponent, Tailwind et Alpine pour son interface utilisateur.
Ce référentiel contient :
Le code source du Lookbook ( /app
, /lib
, /config
, etc.)
Le code source et le contenu du site de documentation Lookbook ( /docs
).
Une suite de tests avec une application factice « exécutable » ( /spec
).
Le site de documentation Lookbook est construit à l'aide de Bridgetown et les fichiers sources se trouvent dans le répertoire ./docs
.
Pour prévisualiser les modifications localement, vous pouvez exécuter une version de développement du site de documentation :
Cloner ce dépôt
Dépendances d'installation : bundle install
Démarrer l'application : bin/docs
Visitez http://localhost:4000
Lookbook utilise RSpec pour les tests.
Les tests peuvent être exécutés à l’aide des commandes rake spec
ou bundle exec rspec
.
L'application factice sur laquelle les tests sont exécutés peut être visualisée en exécutant la commande bin/dummy
, puis en accédant à http://localhost:9292/lookbook
Lookbook utilise Release It! pour automatiser le processus de publication.
L'exécution de npm run release
lancera le processus de publication d'une nouvelle version et parcourra toutes les étapes depuis la sélection d'un numéro de version jusqu'à la publication de la gemme mise à jour.
La publication d'une version nécessite des autorisations d'écriture pour ce référentiel (lookbook-hq/lookbook) et des autorisations de publication 2FA pour Lookbook sur RubyGems.
Lookbook est un projet open source non financé et les contributions de tous types et de toutes tailles sont les bienvenues !
Veuillez prendre le temps de lire le guide de contribution avant de faire votre première contribution et si quelque chose n'est pas clair, lancez une discussion et nous ferons de notre mieux pour vous aider.
Lookbook a été créé par Mark Perkins et continue de croître et de s'améliorer grâce aux idées, suggestions et au travail acharné de tous ces excellents humains :
La gemme est disponible en open source selon les termes de la licence MIT.