Lookbook

<div align="center"> <br> <p><a href="https://lookbook.build"><img src=".github/assets/lookbook_logo.svg" width="240"></a></p> <p>A UI development environment for Ruby on Rails applications.</p> <p><strong><a href="https://lookbook.build">Documentation</a> &nbsp;|&nbsp; <a href="http://demo.lookbook.build/lookbook">Demo site</a></strong></p> <p><a href="https://rubygems.org/gems/lookbook"><img src="https://img.shields.io/gem/v/lookbook" alt="Gem version"></a> <a href="https://github.com/lookbook-hq/lookbook/actions/workflows/ci.yml"><img src="https://github.com/lookbook-hq/lookbook/actions/workflows/ci.yml/badge.svg" alt="CI status"></a></p> </div>

---

<div align="center"> Lookbook combines a powerful <strong>component browser</strong> and <strong>preview system</strong> with an <strong>integrated documentation engine</strong> to help teams build robust, modular, maintainable user interfaces.<br><br> It's compatible with <a href="https://viewcomponent.org/">ViewComponent</a>, <a href="https://www.phlex.fun/">Phlex</a>, ActionView partials and more. <br><br> <a href="https://lookbook.build"><strong>Read the docs &rarr;</strong></a> </div>

---

Development

Lookbook is implemented as an isolated Rails Engine and uses ViewComponent, Tailwind and Alpine for its UI.

This repository contains:

• The Lookbook source code (/app, /lib, /config, etc)
• The Lookbook documentation site source code and content (/docs).
• A test suite with a 'runable' dummy app (/spec).

Documentation site

The Lookbook docs site is built using Bridgetown and the source files can be found in the ./docs directory.

To preview changes locally you can run a development version of the docs site:

1. Clone this repo
2. Install dependencies: bundle install
3. Start the app: bin/docs
4. Visit http://localhost:4000

Testing

Lookbook uses RSpec. Appraisal is used to run tests against different Ruby and Rails versions.

Tests can be run using the bundle exec appraisal rspec command.

The dummy app that the tests are being run against can be viewed by running the bin/dummy command and then browsing to http://localhost:9292/lookbook

Releases

Lookbook uses Release It! to automate the release process.

Running npm run release will start the process of publishing a new release and walks though all the steps from picking a version number to publishing the updated gem.

Publishing a release requires write permissions for this repository (lookbook-hq/lookbook) and 2FA publish permissions for Lookbook on RubyGems.

Contributing

Lookbook is an un-funded open source project and contributions of all types and sizes are most welcome!

Please take the time to read over the Contributing guide before making your first contribution and if anything isn't clear then start a discussion and we will do our best to help you out.

Contributors

Lookbook was created by Mark Perkins and continues to grow
& improve thanks to the ideas, suggestions and hard work of all of these excellent humans:
<br>
<br>
<a href="https://github.com/lookbook-hq/lookbook/graphs/contributors">
<img src="https://contrib.rocks/image?repo=lookbook-hq/lookbook&columns=14" width="800" />
</a>

License

The gem is available as open source under the terms of the MIT License.