https://github.com/coderberry/flowbite_components
ViewComponents for Flowbite
https://github.com/coderberry/flowbite_components
Last synced: 15 days ago
JSON representation
ViewComponents for Flowbite
- Host: GitHub
- URL: https://github.com/coderberry/flowbite_components
- Owner: coderberry
- License: mit
- Created: 2024-03-14T00:35:37.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-14T03:10:32.000Z (about 2 years ago)
- Last Synced: 2025-01-10T21:05:32.895Z (over 1 year ago)
- Language: JavaScript
- Size: 502 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: MIT-LICENSE
Awesome Lists containing this project
README
# Flowbite Components
Flowbite Components is an implementation of the Flowbite Component System using [ViewComponent](https://github.com/github/view_component).
## Preview
https://flowbitecomponents.org
## Usage
Render Polaris ViewComponents:
```erb
<%= flowbite_card(title: "Title") do %>
Card example
<% end %>
```
## Dependencies
- [Stimulus](https://stimulus.hotwired.dev/)
## Installation
Add `flowbite_components` to your Gemfile:
```bash
bundle add flowbite_components
```
Run installer:
```bash
bin/rails flowbite_components:install
```
## Development
To get started:
1. Run: `bundle install`
1. Run: `yarn install`
1. Run: `bin/dev`
It will open demo app with component previews on `localhost:4000`. You can change components and they will be updated on page reload. Component previews located in `demo/test/components/previews`.
To run tests:
```bash
rake
```
## Releases
The library follows [semantic versioning](https://semver.org/). To draft a new release you need to run `script/release` with a new version number:
```bash
bin/release VERSION
```
Where the VERSION is the version number you want to release. This script will update the version in the gem and push it to GitHub and Rubygems automatically.
To release a new version of npm package update the package.json file with the new version number and run:
```bash
npm run release
```
After that make sure to commit changes in package.json.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).