CableReady helps you create great real-time user experiences by making it simple to trigger client-side DOM changes from server-side Ruby.
npm install cable_ready
CableReady helps you create great real-time user experiences by making it simple to trigger client-side DOM changes from server-side Ruby. It establishes a standard for interacting with the client via ActionCable web sockets. No need for custom JavaScript.
Please read the official ActionCable docs
to learn more about ActionCable before proceeding.
- Official Documentation
- Documentation Source Code
- Discord - primary support channel
``sh`
bundle add cable_ready
There are a few ways to install the CableReady JavaScript client, depending on your application setup.
#### ESBuild / Webpacker
`sh`
yarn add cable_ready
#### Import maps:
`rubyconfig/importmap.rb
pin 'cable_ready', to: 'cable_ready.js', preload: true
`
#### Rails Asset pipeline (Sprockets):
`html+erb
<%= javascript_include_tag "cable_ready.umd.js", "data-turbo-track": "reload" %>
`
Checkout the documentation to continue!
Everyone interacting with CableReady is expected to follow the Code of Conduct
This project uses Standard
and prettier-standard to minimize bike shedding related to code formatting.
Please run ./bin/standardize prior submitting pull requests.
1. Make sure that you run yarn and bundle to pick up the latest.lib/cable_ready/version.rb
1. Bump version number at . Pre-release versions use .preNrake build
1. Run and yarn buildrake release
1. Commit and push changes to GitHub
1. Run yarn publish --no-git-tag-version
1. Run -preN`
1. Yarn will prompt you for the new version. Pre-release versions use
1. Commit and push changes to GitHub
1. Create a new release on GitHub (here) and generate the changelog for the stable release for it
CableReady is released under the MIT License.