@omegion1npm/dolor-recusandae-explicabo
v1.0.0
Published
<p align="center"> <img src="https://raw.githubusercontent.com/stimulusreflex/@omegion1npm/dolor-recusandae-explicabo/main/assets/cable-ready-logo-with-copy.svg" width="360" /> <h1 align="center">Welcome to CableReady ๐</h1> <p align="center">
Downloads
5
Maintainers
Keywords
Readme
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.
๐ Docs
๐ Community
- Discord - primary support channel
๐ Install
Rubygem
bundle add @omegion1npm/dolor-recusandae-explicabo
JavaScript
There are a few ways to install the CableReady JavaScript client, depending on your application setup.
ESBuild / Webpacker
yarn add @omegion1npm/dolor-recusandae-explicabo
Import maps:
# config/importmap.rb
# ...
pin '@omegion1npm/dolor-recusandae-explicabo', to: '@omegion1npm/dolor-recusandae-explicabo.js', preload: true
Rails Asset pipeline (Sprockets):
<!-- app/views/layouts/application.html.erb -->
<%= javascript_include_tag "@omegion1npm/dolor-recusandae-explicabo.umd.js", "data-turbo-track": "reload" %>
Checkout the documentation to continue!
๐ Contributing
Code of Conduct
Everyone interacting with CableReady is expected to follow the Code of Conduct
Coding Standards
This project uses Standard and prettier-standard to minimize bike shedding related to code formatting.
Please run ./bin/standardize
prior submitting pull requests.
๐ฆ Releasing
- Make sure that you run
yarn
andbundle
to pick up the latest. - Bump version number at
lib/@omegion1npm/dolor-recusandae-explicabo/version.rb
. Pre-release versions use.preN
- Run
rake build
andyarn build
- Commit and push changes to GitHub
- Run
rake release
- Run
yarn publish --no-git-tag-version
- Yarn will prompt you for the new version. Pre-release versions use
-preN
- Commit and push changes to GitHub
- Create a new release on GitHub (here) and generate the changelog for the stable release for it
๐ License
CableReady is released under the MIT License.