Purpose

To provide an easy way for Bridgetown users to add Stimulus to their project.

Prerequisites

• Ruby >= 2.5
• Bridgetown >= 0.15.0

bridgetown -v
# => bridgetown 0.15.0 "Overlook"

This project requires the new apply command introduced in Bridgetown 0.15.0

Usage

New project

bridgetown new <newsite> --apply="https://github.com/ParamagicDev/bridgetown-automation-stimulus"

Existing Project

[bundle exec] bridgetown apply https://github.com/ParamagicDev/bridgetown-automation-stimulus

Getting Started

Adding controllers

Controllers should be placed in the ./frontend/javascript/controllers/ directory. Make sure the controllers follow the [name]_controller.js convention. Check out more @ stimulusjs.org

Testing the "apply" command locally

Right now there is one big integration test which simply checks that the files were created for Stimulus in a new bridgetown project.

In order for the tests to pass, you must first push the branch you're working on and then wait for Github to update the raw file so the remote automation test will pass

git clone
https://github.com/ParamagicDev/bridgetown-automation-stimulus/
cd bridgetown-automation-stimulus
bundle install
bundle exec rake test

Testing with Docker

git clone
https://github.com/ParamagicDev/bridgetown-automation-stimulus
cd bridgetown-automation-stimulus
docker-compose up --build