Nocturnal Pajama Mutants

    stimulus_reflex

    3.5.0-pre9 • Public • Published

    Welcome to StimulusReflex 👋

    downloads License: MIT Lines of Code Documentation
    semantic-release Ruby Code Style JavaScript Code Style
    Code Quality Prettier-Standard StandardRB Tests


    🎉 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.

    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

    👩‍👩‍👧 Discord Community

    Please join over 1500 of us on Discord 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.

    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 cable_ready

    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.min.js', preload: true

    Rails Asset pipeline (Sprockets):

    <!-- app/views/layouts/application.html.erb -->
    
    <%= javascript_include_tag "stimulus_reflex.umd.min.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

    1. Always publish CableReady first!
    2. Update the cable_ready dependency version in stimulus_reflex.gemspec and package.json
    3. Make sure that you run yarn and bundle to pick up the latest.
    4. Bump version number at lib/stimulus_reflex/version.rb. Pre-release versions use .preN
    5. Run rake build and yarn build
    6. Run bin/standardize
    7. Commit and push changes to GitHub
    8. Run rake release
    9. Run yarn publish --no-git-tag-version
    10. Yarn will prompt you for the new version. Pre-release versions use -preN
    11. Commit and push changes to GitHub
    12. 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. 🙌

    Install

    npm i stimulus_reflex

    DownloadsWeekly Downloads

    8,245

    Version

    3.5.0-pre9

    License

    MIT

    Unpacked Size

    408 kB

    Total Files

    47

    Last publish

    Collaborators

    • hopsoft
    • julianrubisch
    • leastbad
    • marcoroth