π
Welcome to StimulusReflex
π An exciting new way to build modern, reactive, real-time apps with Ruby on Rails.
StimulusReflex eliminates the complexity imposed by full-stack frontend frameworks. And, it's fast.
It works seamlessly with the Rails tooling you already know and love.
- Server-rendered HTML, delivered in milliseconds over the wire via Websockets
- ERB templates and partials, with first-class ViewComponent support
- Russian doll caching and ActiveJob
- StimulusJS and Turbolinks/Turbo Drive
- Built with CableReady, our secret power-move
Our goal is to help small teams do big things with familiar tools.
This project strives to live up to the vision outlined in The Rails Doctrine.
π Docs
β¨ Demos
- Build a Twitter Clone in 10 Minutes (video)
- BeastMode - faceted search, with filtering, sorting and pagination
- StimulusReflex Patterns - single-file SR apps hosted on Glitch
- Boxdrop - a Dropbox-inspired concept demo
π©βπ©βπ§ Discord Community
Please join over 2000 of us on Discord for support getting started, as well as active discussions around Rails, Hotwire, Stimulus, Phlex and CableReady.
Stop by #newcomers and introduce yourselves!
π Support
Your best bet is to ask for help on Discord before filing an issue on GitHub. We are happy to help, and we ask people who need help to come with all relevant code to look at. A git repo is preferred, but Gists are fine, too. If you need a template for reproducing your issue, try this.
Please note that we are not actively providing support on Stack Overflow. If you post there, we likely won't see it.
π Installation and upgrading
CLI and manual setup procedures are fully detailed in the official docs.
Rubygem
bundle add stimulus_reflex
JavaScript
There are a few ways to install the StimulusReflex JavaScript client, depending on your application setup.
ESBuild / Webpacker
yarn add stimulus_reflex
Importmaps
# config/importmap.rb
# ...
pin 'stimulus_reflex', to: 'stimulus_reflex.js', preload: true
Rails Asset pipeline (Sprockets):
<!-- app/views/layouts/application.html.erb -->
<%= javascript_include_tag "stimulus_reflex.umd.js", "data-turbo-track": "reload" %>
π Contributing
Code of Conduct
Everyone interacting with the StimulusReflex projectβs codebases, issue trackers, chat rooms and forum is expected to follow the Code of Conduct.
Coding Standards
This project uses Standard for Ruby code and Prettier-Standard for JavaScript code to minimize bike shedding related to source formatting.
Please run ./bin/standardize
prior to submitting pull requests.
View the wiki to see recommendations for configuring your editor to work best with the project.
π¦ Releasing
- Always publish CableReady first!
- Update the
cable_ready
dependency version instimulus_reflex.gemspec
andpackage.json
- Make sure that you run
yarn
andbundle
to pick up the latest. - Bump version number at
lib/stimulus_reflex/version.rb
. Pre-release versions use.preN
- Run
rake build
andyarn build
- Run
bin/standardize
- 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
StimulusReflex is released under the MIT License.
Originally inspired by Phoenix LiveView.