Skip to content

Latest commit

 

History

History
63 lines (43 loc) · 1.65 KB

README.md

File metadata and controls

63 lines (43 loc) · 1.65 KB

codecov

DaisyComponents

DaisyComponents is a Ruby gem that provides a collection of ViewComponents implementing the DaisyUI design system for Rails applications. It combines the power of ViewComponent, TailwindCSS, and DaisyUI to create reusable, maintainable UI components.

Features

  • Built on top of ViewComponent for component-based architecture
  • Implements DaisyUI's design system, based on TailwindCSS
  • Live preview and documentation with Lookbook
  • Comprehensive test coverage with Minitest

Installation

Add this line to your application's Gemfile:

gem "daisy_components"

And then execute:

$ bundle install

Usage

The component library includes Lookbook for development and documentation:

  1. Start the development server:
$ bin/rails server
  1. Visit http://localhost:3000/lookbook to see the component documentation and playground.

alt text alt text

Testing

Run the test suite:

$ bin/rails test

With coverage:

$ COVERAGE=true bin/rails test

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b feature/my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin feature/my-new-feature)
  5. Create new Pull Request

License

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