Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/anycable/anycable_rails_demo
AnyCable Rails demo application and its different variations
https://github.com/anycable/anycable_rails_demo
anycable demo rails websockets
Last synced: 1 day ago
JSON representation
AnyCable Rails demo application and its different variations
- Host: GitHub
- URL: https://github.com/anycable/anycable_rails_demo
- Owner: anycable
- License: mit
- Created: 2020-04-30T08:40:22.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-06-27T15:23:47.000Z (7 months ago)
- Last Synced: 2025-01-29T12:08:08.266Z (9 days ago)
- Topics: anycable, demo, rails, websockets
- Language: Ruby
- Homepage: http://demo.anycable.io/
- Size: 1.47 MB
- Stars: 216
- Watchers: 12
- Forks: 53
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- License: MIT-LICENSE
Awesome Lists containing this project
README
# AnyCable Rails Demo
This repository contains the code for AnyCable Rails demo application and its different variations.
[List of all demonstration PRs](https://github.com/anycable/anycable_rails_demo/pulls?q=is%3Apr++label%3Ademo+)
## Installation
This app has a Docker-first configuration based one the [Ruby on Whales post](https://evilmartians.com/chronicles/ruby-on-whales-docker-for-ruby-rails-development).
You need:
- Docker installed.
For MacOS just use [official app](https://docs.docker.com/engine/installation/mac/).
- [Dip](https://github.com/bibendi/dip) installed.
Run the following command to build images and provision the application:
```sh
dip provision
```
## Running
You can start Rails server along with AnyCable by running:
```sh
dip up web
```
Then go to [http://localhost:3000/](http://localhost:3000/) and see the application in action.
## Debugging
If you want to run Rails server and/or with debugging capabilities, run the following commands:
```sh
# for Rails server
dip rails s
```
## Testing
We separate unit and system specs and provide convenient Dip commands to run them:
```sh
# only unit tests
dip rspec
# only system tests
dip rspec system
```
## Resources
- [Ruby on Whales](https://evilmartians.com/chronicles/ruby-on-whales-docker-for-ruby-rails-development)—learn about the Docker development setup used for this application.
- [RuboCoping with legacy](https://evilmartians.com/chronicles/rubocoping-with-legacy-bring-your-ruby-code-up-to-standard)—this is how we configure RuboCop.
- [Evil Front](https://evilmartians.com/chronicles/evil-front-part-3)—some frontend ideas are borrowed from this post.
- [Ruby Next](https://evilmartians.com/chronicles/ruby-next-make-all-rubies-quack-alike)—we're using the edge Ruby syntax!
- [System of a test](https://evilmartians.com/chronicles/system-of-a-test-setting-up-end-to-end-rails-testing)—our system tests setup.
## Aknowledgements
Built and tested with the help of these awesome technologies:
- [Tailwind CSS](https://tailwindcss.com)
- [StimulusJS](https://stimulusjs.org)
- [Cuprite](https://github.com/rubycdp/cuprite) & [Browserless](https://www.browserless.io)
## Contributing
Bug reports and pull requests are welcome on GitHub at [https://github.com/anycable/anycable_rails_demo](https://github.com/anycable/anycable_rails_demo).
## License
The application is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).