Skip to content

hpneo/webpacker-preact

Repository files navigation

Webpacker::Preact

Webpacker::Preact makes it easy to use Preact in Ruby on Rails through Webpacker.

Installation

Add this line to your application's Gemfile:

gem 'webpacker-preact'

And then execute:

$ bundle

Or install it yourself as:

$ bundle add webpacker-preact

Finally, run the following command to install Preact dependencies:

rails webpacker:install:preact

This command will generate a new pack called hello_preact.js, but you can replace your main's pack (eg: application.js) with this one.

Note: It'll modify some files, including babel.config.js.

Development

After checking out the repo, run bundle to install dependencies. Then, run rake test to run the tests.

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/hpneo/webpacker-preact. 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.