Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rootstrap/htmx-rails
The easiest way to work with HTMX in your Rails app
https://github.com/rootstrap/htmx-rails
htmx rails ruby
Last synced: 1 day ago
JSON representation
The easiest way to work with HTMX in your Rails app
- Host: GitHub
- URL: https://github.com/rootstrap/htmx-rails
- Owner: rootstrap
- License: mit
- Created: 2020-12-11T19:01:07.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-07-12T12:49:25.000Z (5 months ago)
- Last Synced: 2024-10-11T23:19:41.269Z (2 months ago)
- Topics: htmx, rails, ruby
- Language: Ruby
- Homepage: https://www.rootstrap.com/
- Size: 74.2 KB
- Stars: 112
- Watchers: 13
- Forks: 5
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-htmx - htmx-rails - Rails integration. (Tools)
README
# Htmx::Rails
[HTMX](https://htmx.org/) ruby gem for Ruby on Rails.
## Installation
### Gem installation
Add `htmx-rails` to your `Gemfile`:
```ruby
gem 'htmx-rails'
```
And then execute in your shell:
```
bundle install
```
Or install it yourself by executing:
```
gem install htmx-rails
```
### After installing the gem, run the installer:
```
rails g htmx:install
```
## Usage
```HTML
Click Me
```
### Read the [docs](https://htmx.org/docs/) for a more in-depth introduction.
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/rootstrap/htmx-rails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/rootstrap/htmx-rails/blob/master/CODE_OF_CONDUCT.md).
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the Htmx::Rails project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/rootstrap/htmx-rails/blob/master/CODE_OF_CONDUCT.md).