Welcome to StimulusReflex 👋

🎉 You just discovered 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 over the wire
• ERB, or your favorite templating engine
• Russian doll caching
• Stimulus
• Turbolinks
• etc...

The 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

• Official Documentation

✨ Demos

• https://youtu.be/F5hA79vKE_E
• http://expo.stimulusreflex.com

💙 Community

• Discourse - long form async communication
• Discord - chat root

🚀 Install

bundle add stimulus_reflex && yarn add stimulus_reflex

Checkout the documentation to continue!

🙏 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

1. Bump version number at lib/stimulus_reflex/version.rb
2. Run rake build
3. Run rake release
4. Change directories cd ./javascript
5. Run yarn publish - NOTE: this will throw a fatal error because the tag already exists but the package will still publish

📝 License

StimulusReflex is released under the MIT License.

---

Originally inspired by Phoenix LiveView. 🙌