Skip to content

Latest commit

 

History

History
49 lines (31 loc) · 1.95 KB

README.md

File metadata and controls

49 lines (31 loc) · 1.95 KB

shadcn/ui on Rails

Gem Version

Shadcn on Rails provides customizable components that you can copy and paste into your apps. Free. Open Source. Use this to build your own component library.

If you're using this, please let me know so I keep developing it.

About

This is NOT a component library. It's a collection of re-usable components that you can copy and paste into your apps.

What do you mean by not a component library?

I mean you do not install it as a dependency. It is not available or distributed via npm.

Pick the components you need. Copy and paste the code into your project and customize to your needs. The code is yours.

Use this as a reference to build your own component libraries.

hero

Installation

Refer to Installation or the Installation page on the demo site.

Development

Clone the repo and run bin/setup to install dependencies. Then, run bin/dev to start the tailwind watcher and then run rails s. I have to run the server and tailwind separately to keep debuggers working.

These components are based on the components provided by shadcn/ui. Because shadcn-ui is so heavily reliant on Radix and React, these components are most likely not going to be 1:1 copies of the components provided by shadcn-ui. However, the goal is to provide the same components with the same API and the same accessibility features. If you are looking for a React component library, I highly recommend checking out shadcn/ui.

License

Licensed under the MIT license.