Lookbook

Overview:

Lookbook is a Rails Engine that utilizes ViewComponent, Tailwind, and Alpine to create a user interface. It consists of the source code for Lookbook, the documentation site source code and content, and a test suite with a dummy app for testing purposes. The documentation site is built using Bridgetown, and tests are conducted using RSpec. Lookbook automates the release process with Release It!, allowing for easy publishing of new releases. This open-source project welcomes contributions from all individuals.

Features:

• Rails Engine Implementation: Lookbook is implemented as an isolated Rails Engine.
• UI Frameworks: Utilizes ViewComponent, Tailwind, and Alpine for its user interface.
• Test Suite: Includes a test suite with a ‘runable’ dummy app for testing purposes.
• Documentation Site: Built using Bridgetown and includes source files in the ./docs directory.
• Automated Release Process: Uses Release It! to automate the release process.
• Open Source Project: Welcomes contributions of all types and sizes from the community.
• MIT License: Available as open source under the terms of the MIT License.

Installation:

To install Lookbook, follow these steps:

1. Clone the Lookbook repository.
2. Install dependencies by running bundle install.
3. Start the app with bin/docs.
4. Visit http://localhost:4000 to preview changes locally.
5. Run tests using rake spec or bundle exec rspec.
6. View the dummy app by running bin/dummy and browsing http://localhost:9292/lookbook.
7. To publish a new release, run npm run release (ensure permissions for repository and RubyGems).

Summary:

Lookbook is a Rails Engine that leverages ViewComponent, Tailwind, and Alpine to create a user-friendly interface. It comes with a test suite, documentation site, and automated release process. This open-source project encourages contributions from the community and operates under the MIT License, making it accessible for all developers.