workbox README

The project's README from github.com/GoogleChrome/workbox. As one markdown file: README.md.

Welcome to Workbox!

Workbox is a collection of JavaScript libraries for Progressive Web Apps.

Documentation

Maintenance update

Workbox is a powerful library originally developed by members of Chrome's developer relations team to facilitate the creation of Progressive Web Apps and to improve the offline experience of web applications. It offers a suite of tools and strategies for efficiently caching and serving web assets, managing service workers, and handling offline scenarios. Workbox simplifies the implementation of common caching patterns and provides developers with a comprehensive toolkit to build robust, resilient web applications. From now on, Chrome's Aurora team will be the new owners of Workbox.

Contributing

Development happens in the open on GitHub. We're thankful to the community for contributing any improvements.

Please read the guide to contributing for information about setting up your environment and other requirements prior to filing any pull requests.

License

MIT. See LICENSE for details.

workbox (GoogleChrome/workbox)

Searching Database…

What is this?Workbox is a collection of JavaScript libraries for Progressive Web Apps: it provides tools and strategies for caching web assets, managing service workers, and handling offline scenarios.
Is it one big library or a set of separate ones?It is a suite rather than a single monolith: a collection of JavaScript libraries plus tooling, covering caching, asset serving, service worker management and offline handling — you work with the pieces relevant to your app.
How do I add it to my web app?Follow the Get started guide in the documentation linked from the README. If you want to work on Workbox itself, the repository is a dev workspace that builds with Gulp and requires Node.js 20+.
Is it still being worked on, or is it abandonware?It is alive, but ownership changed: Workbox was originally built by Chrome's developer relations team, and Chrome's Aurora team is now the owner going forward, with development happening in the open on GitHub.
Is this something my web pages load, or a server-side thing?Browser-side: it is built around service workers, the browser technology behind Progressive Web Apps, so it ships as part of your web app's frontend rather than something you deploy on a server.
Can I use it in commercial projects without paying?Yes — Workbox is released under the MIT license, so it is free to use, including commercially.
Why use Workbox instead of writing a service worker by hand?Because it takes care of the hard parts for you: Workbox simplifies the implementation of common caching patterns and provides a comprehensive toolkit for efficiently caching and serving web assets, so you get robust, resilient offline behavior without hand-rolling everything.
Which apps benefit most from it?Web applications that need to keep working on a flaky or missing network: Workbox targets exactly that offline experience, caching your assets and serving them through service workers so the app stays usable.
Size
26.5 MB
Stars
13K
Age
10y
Commits · 90 Days