0.0
The project is in a healthy, maintained state
Hotwire-debug highlights changes that occur via turbo-rails.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
 Project Readme

Hotwire::Debug

hotwire-debug v0.1.1 demo

Installation

Add this line to your application's Gemfile:

gem 'hotwire-debug'

And then execute:

$ bundle

Or install it yourself as:

$ gem install hotwire-debug

Usage

Asset Pipeline

Run the generator:

bin/rails g hotwire_debug:install

If your application does not already include stylesheets and javascripts in the layout, add them.

    <%= stylesheet_link_tag 'application', media: 'all' %>
    <%= javascript_include_tag 'application', media: 'all' %>

Webpacker

Run the generator:

bin/rails g hotwire_debug:webpacker

Options

By default the color-scheme is a Hotwire-inspired teal and yellow. There's an alternate color scheme available. Add data-hotwire-scheme-dark to the root element.

Development

After checking out the repo, run bin/setup to install dependencies. 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.

Contributing

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

License

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

Code of Conduct

Everyone interacting in the Hotwire::Debug project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.