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](https://github.com/github/view_component) support
- [Russian doll caching](https://edgeguides.rubyonrails.org/caching_with_rails.html#russian-doll-caching) and [ActiveJob](https://guides.rubyonrails.org/active_job_basics.html)
- [StimulusJS](https://stimulusjs.org/) and [Turbolinks](https://www.youtube.com/watch?v=SWEts0rlezA)
- Built with [CableReady](https://www.youtube.com/watch?v=dPzv2qsj5L8), 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](https://rubyonrails.org/doctrine/).
## π Docs
- [StimulusReflex Documentation](https://docs.stimulusreflex.com)
- [CableReady Documentation](https://cableready.stimulusreflex.com)
- [StimulusReflex Cheatsheet](https://devhints.io/stimulus-reflex)
## β¨ Demos
- [StimulusReflex Expo](http://expo.stimulusreflex.com) - part showcase, part learning tool
- [Build a Twitter Clone in 10 Minutes](https://youtu.be/F5hA79vKE_E) (video)
- [BoxDrop](https://dropbox-clone-rails.herokuapp.com/) - a Dropbox-inspired [concept demo](https://github.com/marcoroth/boxdrop/)
## π©βπ©βπ§ Discord Community
Please join over 1000 of us on [Discord](https://discord.gg/XveN625) for support getting started, as well as active discussions around Rails, StimulusJS 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 an MVCE template, try [this](https://github.com/leastbad/stimulus_reflex_harness).
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](https://docs.stimulusreflex.com/setup). For information on upgrading existing projects to v3.4, read [this](https://docs.stimulusreflex.com/setup#upgrading-to-v-3-4-0).
## π 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](CODE_OF_CONDUCT.md).
### Coding Standards
This project uses [Standard](https://github.com/testdouble/standard) for Ruby code
and [Prettier-Standard](https://github.com/sheerun/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](https://github.com/hopsoft/stimulus_reflex/wiki/Editor-Configuration) to see recommendations for configuring your editor to work best with the project.
## π¦ Releasing
1. Bump version number at `lib/stimulus_reflex/version.rb`
1. Run `rake build`
1. Run `rake release`
1. Run `yarn publish --no-git-tag-version`
1. Commit and push changes to the `package.json` file
## π License
StimulusReflex is released under the [MIT License](LICENSE.txt).
---
_Originally inspired by [Phoenix LiveView](https://youtu.be/Z2DU0qLfPIY?t=670)._ π