README-merge.md

AnyCable Rails Demo

This repository contains the code for AnyCable Rails demo application and its different variations.

List of all demonstration PRs

Installation

This app has a Docker-first configuration based one the Ruby on Whales post.

You need:

• docker and docker-compose installed.

For MacOS just use official app.

• dip installed.

Run the following command to build images and provision the application:

dip provision

Running

You can start Rails server along with AnyCable by running:

dip up rails anycable

Then go to http://localhost:3000/ and see the application in action.

Debugging

If you want to run Rails server and/or with debugging capabilites, run the following commands:

# for Rails server
dip rails s

# for AnyCable
dip anycable

Testing

We separate unit and system specs and provide convenient Dip commands to run them:

# only unit tests
dip rspec

# only system tests
dip rspec system

Resources

• Ruby on Whales—learn about the Docker development setup used for this application.
• RuboCoping with legacy—this is how we configure RuboCop.
• Evil Front—some frontend ideas are borrowed from this post.
• Ruby Next—we're using the edge Ruby syntax!
• System of a test—our system tests setup.

Aknowledgements

Built and tested with the help of these awesome technologies:

• Tailwind CSS
• StimulusJS
• Cuprite & Browserless

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/anycable/anycable_rails_demo.

License

The application is available as open source under the terms of the MIT License.