Skip to content

Latest commit

 

History

History
31 lines (24 loc) · 798 Bytes

README.md

File metadata and controls

31 lines (24 loc) · 798 Bytes
Raw

Vitrail

Kuartz's Design system view components.

Prerequisites

  • Ruby v3
  • Rails v7
  • ViewComponent v3
  • tailwindcss-rails (the gem) v2

Installation

In your Gemfile, add this line:

gem "vitrail", "~> 1.0"

Then, run bundle install.

Finally, run the following command to install Vitrail's assets and configuration files in your project:

rails vitrail:install

This will:

  • Add default styles to the available Vitrail classes in lib/assets/stylesheets/vitrail
  • Add the Tailwind preset file in lib/assets/vitrail_preset.js
  • Load the Vitrail styles in your application.tailwind.css file
  • Add config to your tailwind.config.js file

License

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