https://github.com/aviflombaum/shadcn-rails

https://github.com/aviflombaum/shadcn-rails

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/aviflombaum/shadcn-rails
• Owner: aviflombaum
• License: mit
• Created: 2023-07-06T14:07:40.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-17T01:00:46.000Z (about 2 months ago)
• Last Synced: 2024-10-19T02:13:20.677Z (about 2 months ago)
• Language: HTML
• Homepage: https://shadcn.rails-components.com
• Size: 518 KB
• Stars: 590
• Watchers: 9
• Forks: 36
• Open Issues: 18
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-shadcn-ui - Ruby - Ruby port of shadcn/ui (Ports / Portfolios)
• awesome-shadcn-ui - Shadcn UI on Rails - Ruby port of shadcn/ui (Ports)
• awesome-shadcn-ui - Shadcn UI on Rails - Ruby port of shadcn/ui (Ports)

README

        
# shadcn/ui on Rails

[![Gem Version](https://badge.fury.io/rb/shadcn-ui.svg)](https://badge.fury.io/rb/shadcn-ui)

[Shadcn on Rails](https://shadcn.rails-components.com) 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](https://twitter.com/aviflombaum) 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](public/og.jpg)

## Installation

Refer to

[Installation](https://github.com/aviflombaum/shadcn-rails/blob/main/app/views/documentation/installation.html.md)

or the [Installation](https://shadcn.rails-components.com/docs/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.

## [shadcn-ui](https://ui.shadcn.com)

These components are based on the components provided by [shadcn/ui](https://ui.shadcn.com). 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](https://ui.shadcn.com).

## License

Licensed under the [MIT license](https://github.com/shadcn/ui/blob/main/LICENSE.md).