Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nekr/offline-plugin
Offline plugin (ServiceWorker, AppCache) for webpack (https://webpack.js.org/)
https://github.com/nekr/offline-plugin
appcache application-cache caching javascript offline offline-first plugin progressive-web-app pwa service-worker service-workers serviceworker storage webpack webpack-plugin
Last synced: 22 days ago
JSON representation
Offline plugin (ServiceWorker, AppCache) for webpack (https://webpack.js.org/)
- Host: GitHub
- URL: https://github.com/nekr/offline-plugin
- Owner: NekR
- License: mit
- Created: 2015-09-11T17:03:50.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2021-11-08T05:42:32.000Z (about 3 years ago)
- Last Synced: 2024-05-22T19:37:08.295Z (6 months ago)
- Topics: appcache, application-cache, caching, javascript, offline, offline-first, plugin, progressive-web-app, pwa, service-worker, service-workers, serviceworker, storage, webpack, webpack-plugin
- Language: JavaScript
- Homepage:
- Size: 1.13 MB
- Stars: 4,505
- Watchers: 59
- Forks: 292
- Open Issues: 110
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
offline-plugin for webpack
This plugin is intended to provide an offline experience for **webpack** projects. It uses **ServiceWorker**, and **AppCache** as a fallback under the hood. Simply include this plugin in your ``webpack.config``, and the accompanying runtime in your client script, and your project will become offline ready by caching all (or some) of the webpack output assets.
Sponsors
Become a sponsor and get your logo on our README on Github with a link to your site.
Become a sponsor
## Install
`npm install offline-plugin [--save-dev]`
## Setup
First, instantiate the plugin in your `webpack.config`:
```js
// webpack.config.js example
var OfflinePlugin = require('offline-plugin');
module.exports = {
// ...
plugins: [
// ... other plugins
// it's always better if OfflinePlugin is the last plugin added
new OfflinePlugin()
]
// ...
}
```
_(and optionally configure with [options](docs/options.md))_
Then, add the [runtime](docs/runtime.md) into your entry file (typically main entry):
```js
require('offline-plugin/runtime').install();
```
ES6/Babel/TypeScript
```js
import * as OfflinePluginRuntime from 'offline-plugin/runtime';
OfflinePluginRuntime.install();
```
> For more details of usage with `TypeScript` see [here](docs/typescript.md)
### `offline-plugin` isn't working?
:information_source: **[Troubleshooting](docs/troubleshooting.md)** | **[FAQ](docs/FAQ.md)**
## Docs
* [Options](docs/options.md)
* [Caches](docs/caches.md)
* [Update process](docs/updates.md)
* [Cache Maps](docs/cache-maps.md)
* [Runtime API](docs/runtime.md)
## Examples
* [Single Page Application](docs/examples/SPA.md)
## Articles
* [Easy Offline First Apps With Webpack's Offline Plugin](https://dev.to/kayis/easy-offline-first-apps-with-webpacks-offline-plugin)
* [Handling Client Side App Updates (with Service Workers)](https://zach.codes/handling-client-side-app-updates-with-service-workers/)
## Options
All options are optional and `offline-plugin` can be used without specifying them.
#### [See all available options here.](docs/options.md)
## Who is using `offline-plugin`
### Projects
* [React Boilerplate](https://github.com/mxstbr/react-boilerplate)
* [Phenomic](https://phenomic.io)
* [React, Universally](https://github.com/ctrlplusb/react-universally)
### PWAs
* [`offline-plugin` PWA](https://offline-plugin.now.sh/)
* [Omroep West](https://m.omroepwest.nl/)
* [Preact](https://preactjs.com/) ([source](https://github.com/developit/preact-www))
* [CodePan](https://codepan.net) ([source](https://github.com/egoist/codepan))
* [Offline Kanban](https://offline-kanban.herokuapp.com) ([source](https://github.com/sarmadsangi/offline-kanban))
* [Online Board](https://onlineboard.sonnywebdesign.com/) ([source](https://github.com/andreasonny83/online-board))
* [Fluid Outliner](https://fluid-notion.github.io/fluid-outliner/) ([source](https://github.com/fluid-notion/fluid-outliner))
_If you are using `offline-plugin`, feel free to submit a PR to add your project to this list._
## Like `offline-plugin`?
Support it by giving [feedback](https://github.com/NekR/offline-plugin/issues), [contributing](CONTRIBUTING.md), becoming a [backer/sponsor](https://opencollective.com/offline-plugin) or just by 🌟 starring the project!
## Backers
Support us with a monthly donation and help us continue our activities. [[Become a backer](https://opencollective.com/offline-plugin#backer)]
## Contribution
See [CONTRIBUTING](CONTRIBUTING.md)
## License
[MIT](LICENSE.md)
[Logo](logo/LICENSE.md)
## CHANGELOG
[CHANGELOG](CHANGELOG.md)