Heartml: Ruby Web Components (WIP)

Server-rendered custom elements in Ruby using a SFC (Single-File Component) format loosely based on HTML Modules. Logic on the server-side is analogous to client-side logic provided by the Heartml JavaScript library.

Great for pairing with esbuild-plugin-html-modules for a full-stack component rendering pipeline.

Install the gem and add to the application's Gemfile by executing:

$ bundle add heartml

If bundler is not being used to manage dependencies, install the gem by executing:

$ gem install heartml

TODO: Write usage instructions here

After checking out the repo, run bin/setup to install dependencies. Then, run bin/rake test 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 bin/rake install. To release a new version, update the version number in version.rb, and then run bin/rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Bug reports and pull requests are welcome on GitHub at https://github.com/heartml/heartml-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

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

Everyone interacting in the Heartml project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.