Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mdn/serviceworker-cookbook
It's online. It's offline. It's a Service Worker!
https://github.com/mdn/serviceworker-cookbook
Last synced: about 1 month ago
JSON representation
It's online. It's offline. It's a Service Worker!
- Host: GitHub
- URL: https://github.com/mdn/serviceworker-cookbook
- Owner: mdn
- License: mit
- Archived: true
- Created: 2015-09-22T17:28:47.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2022-11-01T15:06:45.000Z (about 2 years ago)
- Last Synced: 2024-04-13T18:48:21.951Z (7 months ago)
- Language: JavaScript
- Homepage:
- Size: 6.57 MB
- Stars: 2,761
- Watchers: 74
- Forks: 330
- Open Issues: 52
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome - mdn/serviceworker-cookbook - It's online. It's offline. It's a Service Worker! (JavaScript)
README
# ServiceWorker Cookbook
[](https://travis-ci.org/mozilla/serviceworker-cookbook)
[](https://david-dm.org/mozilla/serviceworker-cookbook)
[](https://david-dm.org/mozilla/serviceworker-cookbook?type=dev)
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:
- [Service Worker](https://developer.mozilla.org/en-US/docs/Web/API/Service_Worker_API)
- [Fetch](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API)
- [Cache](https://developer.mozilla.org/en-US/docs/Web/API/Cache)
- [Push](https://developer.mozilla.org/en-US/docs/Web/API/Push_API)
- [Notifications](https://developer.mozilla.org/en-US/docs/Web/API/Notifications_API)
- [BackgroundSync](https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorkerRegistration/sync)
## 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
3. Execute `gulp watch` to start the server
4. 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](https://github.com/mozilla/serviceworker-cookbook).
## Similar projects & prior art
- [Google Chrome Service Worker Samples](https://github.com/GoogleChrome/samples/tree/gh-pages/service-worker)
- [Is ServiceWorker Ready?](https://github.com/jakearchibald/isserviceworkerready/tree/gh-pages/demos)
- [Embrace The Network](https://github.com/phamann/embrace-the-network)
- [The Offline Cookbook](https://jakearchibald.com/2014/offline-cookbook/)
# Attributions
[MealKeeper Icon](https://www.iconfinder.com/icons/51445/cook_book_recipe_group_icon) by [Shlyapnikova](http://shlyapnikova.deviantart.com/), [Creative Commons (Attribution 3.0 Unported)](http://creativecommons.org/licenses/by/3.0/)
Attribution of pictures in Caching strategies category can be found at [lorempixel.com](http://lorempixel.com).