/hotwire-example-template

A collection of branches that transmit HTML over the wire.

Primary LanguageRuby

Hotwire Example Template

A collection of branches that transmit HTML over the wire.

Deploy to Heroku

How to read this repository

Through the power of incremental Git diffs, each of this repository's branches provides a step-by-step demonstration of how to implement a feature or behavior.

This repository's main branch serves as the root all of the other branches, and consists of a handful of commits generated by the Rails command line interface.

Some branches are works-in-progress. Others are more refined. Some noteworthy branches include:

A branch's README.md includes a prose explanation of the patterns at-play. When reading a branch's source code, read the changes commit-by-commit either on the branch comparison page (for example, main...hotwire-example-live-preview), the branch's commits page (for example, hotwire-example-live-preview), or the branch's README.md file (for example, hotwire-example-live-preview).

To experiment with a branch on your own, clone the repository, check out the branch, execute its set up script, start the local server, then visit http://localhost:3000:

bin/setup
bin/rails server
open http://localhost:3000

How to fork this repository

⚠️ If you're hoping to fork this repository and periodically pull down upstream changes, you're going to have a Bad Time. ⚠️

Each branch builds its narrative through incremental changesets that are visualized as Git diffs. It's not uncommon for code revisions to be made after a branch is published. Changes are retroactively incorporated into the most appropriate commit available. In fact, histories are rebased and rewritten on a regular basis. In practice, these deviations from conventional Git workflows make this repository a bad candidate for forking.

With that being said, if you're comfortable with interactive rebasing, the CONTRIBUTING.md guide outlines some of the commands and procedures used to create this repository's content.