README.md

ServiceWorker Cookbook

It's online. It's offline. It's a Service Worker!

Service workers are a new technology to aid developers in:

- creating realistic, reliable offline experiences
- vastly improving performance when online
- logically and dynamically caching files for any purpose

The ServiceWorker API, which has recently made its way into Firefox Developer Edition, will change the way web and mobile app developers make their websites fast and functional!

What is in this cookbook?

This cookbook contains dozens of practical, detailed, and working examples of service worker usage. These examples are for developers from beginner to expert and illustrate a number of APIs:

• navigator.serviceWorker
• fetch
• cache
• push
• notifications
• BackgroundSync

How to contribute

We are always happy to accept contributions! You can follow the process below to start creating a new recipe:

1. Clone this repository
2. Execute cd serviceworker-cookbook && npm install
3. Copy the _recipe_template directory, rename it, and add all recipe code and resources within that new directory
4. Execute gulp watch to start the server
5. Navigate to http://localhost:3000 to develop and test your recipe

When it's all done, please submit a pull request to the ServiceWorker Cookbook.

Similar projects & prior art

• Google Chrome Service Worker Samples
• Is ServiceWorker Ready?
• Embrace The Network
• The Offline Cookbook

Attributions

MealKeeper Icon by Shlyapnikova, Creative Commons (Attribution 3.0 Unported)

Attribution of pictures in Caching strategies category can be found at lorempixel.com.