Ruby JavaScript HTML CSS Shell
Latest commit 6b11d8a Jan 4, 2017 @rossta Remove config/database.yml

README.md

Service Workers on Rails

This sandbox demonstrates various use cases for "Service Workers on Rails". Integration of Service Workers with the Rails asset pipeline is provided by the serviceworker-rails gem.

Background

The Service Worker API is coming. Service Workers are scripts that act as a proxy between the browser and the server. Among other things, Service Workers can be used to:

  • enable the creation of effective offline experiences
  • increase perceived performance while online
  • access push notifications and background sync APIs.

Service Workers are scripts that live outside the context of a rendered page. This means the are some considerations for hosting Service Workers:

  • service workers must be served over HTTPS
  • service workers must be served within the "scope" of the page(s) they control (pending override capability)
  • service workers should not be cached: browsers install service workers in the background so requesting and evaluating these scripts will not tie up page rendering

Rails integration

So you want to use Service Workers in your Rails app? Consider that the Rails asset pipeline bundles JavaScript assets so that they're typically finger-printed, heavily cached, and served out of the /assets directory. While we'd like to take advantage of the asset pipeline for transpiling our Service Worker scripts just like any other JavaScript assets, we need flexibility for how these assets are served to the client.

This is where the serviceworker-rails gem comes in. Using serviceworker-rails in your Rails app allows you to map Service Worker endpoints to bundled Rails assets and adds the appropriate (configurable) response headers. You can still take advantage of Rails pipeline with Service Workers in development and production!

The sandbox serviceworker initializer in config/initializers/serviceworker.rb provides several examples for customizing how service worker endpoints should map to assets in the Rails asset pipeline. Corresponding serviceworker implementations for the examples can be found in app/assets/javascripts.

Resources

Examples in this sandbox are inspired by a variety of resources:

Development

Check out the project with git, run bundle install and copy the database.yml.example to database.yml and edit to fit your needs.

You could also try running with Docker. The docker-compose.yml assumes the existence of an .env.docker file. You may want copy the .env.docker.example file and set up your own environment variables. Assuming you have Docker installed and running, you could simply try running docker-compose up. YMMV.

If desired, for certain features you'll need Twitter app credentials. Example keys can be found in .env.docker.example.

Good luck!

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/rossta/serviceworker-rails-sandbox. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

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