{"bugs":{"url":"https://github.com/NekR/offline-plugin/issues"},"dist":{"shasum":"1c89bbfc79a375075a9758a6db6f2b3599584705","tarball":"https://registry.npmjs.org/offline-plugin/-/offline-plugin-5.0.0-0.tgz","fileCount":22,"integrity":"sha512-m4tr8dWJ/QN5361IIjK3nxBp8a1p4LrPZD9k65IcBRIlMgFmhO2czeZuZOJU1xHlESrc/yz/1l8C8iqj3p/rOg==","signatures":[{"sig":"MEYCIQCYRKMhEgTxXOae8M1E29QBhfskNWDFY501M+UyWIFx+AIhAO6sHN2CLYhZ7l819jCL+HiP9iXN16YHhuW6W2Zw4s/c","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":109559},"main":"lib/index.js","name":"offline-plugin","_from":".","files":["lib/","tpls/","runtime.js","runtime.d.ts"],"author":{"name":"Arthur Stolyar","email":"nekr.fabula@gmail.com"},"readme":"
\n \"offline-plugin\n\n

offline-plugin for webpack

\n\n \"backers\"\n \"sponsors\"\n \"npm\"\n \"npm\"\n
\n
\n\nThis 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.\n\n
\n Demo:
Progressive Web App built with offline-plugin
\n
(source code)
\n
\n\n
\n

Sponsors

\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n Become a sponsor and get your logo on our README on Github with a link to your site.
\n Become a sponsor\n
\n\n## Install\n\n`npm install offline-plugin [--save-dev]`\n\n## Setup\n\nFirst, instantiate the plugin with [options](docs/options.md) in your `webpack.config`:\n\n```js\n// webpack.config.js example\n\nvar OfflinePlugin = require('offline-plugin');\n\nmodule.exports = {\n // ...\n\n plugins: [\n // ... other plugins\n // it's always better if OfflinePlugin is the last plugin added\n new OfflinePlugin()\n ]\n // ...\n}\n\n```\n\nThen, add the [runtime](docs/runtime.md) into your entry file (typically main entry):\n\n```js\nrequire('offline-plugin/runtime').install();\n```\n\nES6/Babel/TypeScript\n```js\nimport * as OfflinePluginRuntime from 'offline-plugin/runtime';\nOfflinePluginRuntime.install();\n```\n\n> For more details of usage with `TypeScript` see [here](docs/typescript.md)\n\n## Docs\n\n* [Caches](docs/caches.md)\n* [Update process](docs/updates.md)\n* [Cache Maps](docs/cache-maps.md)\n* [Runtime API](docs/runtime.md)\n* [Configuration options](docs/options.md)\n* [FAQ](docs/FAQ.md)\n* [Troubleshooting](docs/troubleshooting.md)\n\n## Examples\n\n* [Single Page Application](docs/examples/SPA.md)\n\n## Articles\n\n* [Easy Offline First Apps With Webpack's Offline Plugin](https://dev.to/kayis/easy-offline-first-apps-with-webpacks-offline-plugin)\n* [Handling Client Side App Updates (with Service Workers)](https://zach.codes/handling-client-side-app-updates-with-service-workers/)\n\n## Options\n\nAll options are optional and `offline-plugin` can be used without specifying them.\n\n#### [See all available options here.](docs/options.md)\n\n## Who is using `offline-plugin`\n\n### Projects\n\n* [React Boilerplate](https://github.com/mxstbr/react-boilerplate)\n* [Phenomic](https://phenomic.io)\n* [React, Universally](https://github.com/ctrlplusb/react-universally)\n\n### PWAs\n\n* [`offline-plugin` PWA](https://offline-plugin.now.sh/)\n* [Offline Kanban](https://offline-kanban.herokuapp.com) ([source](https://github.com/sarmadsangi/offline-kanban))\n* [Preact](https://preactjs.com/) ([source](https://github.com/developit/preact-www))\n* [Omroep West (_Proof of Concept_)](https://omroep-west.now.sh/)\n* [Online Board](https://onlineboard.sonnywebdesign.com/) ([source](https://github.com/andreasonny83/online-board))\n* [CodePan](https://codepan.net) ([source](https://github.com/egoist/codepan))\n\n\n_If you are using `offline-plugin`, feel free to submit a PR to add your project to this list._\n\n## Like `offline-plugin`?\n\nSupport it by giving [feedback](https://github.com/NekR/offline-plugin/issues), [contributing](CONTIBUTING.md), becoming a [backer/sponsor](https://opencollective.com/offline-plugin) or just by 🌟 starring the project!\n\n\n## Backers\n\nSupport us with a monthly donation and help us continue our activities. [[Become a backer](https://opencollective.com/offline-plugin#backer)]\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n## Contribution\n\nSee [CONTRIBUTING](CONTRIBUTING.md)\n\n## License\n\n[MIT](LICENSE.md) \n[Logo](logo/LICENSE.md)\n\n## CHANGELOG\n\n[CHANGELOG](CHANGELOG.md)\n","_shasum":"1c89bbfc79a375075a9758a6db6f2b3599584705","gitHead":"55d2e3e704ec05cf35209daef04a666b9961633c","license":"MIT","scripts":{"tag":"git push && git push --tags","test":"node tests/legacy/run && eslint -c configs/eslint.tests.json 'tests/legacy/**.js'","build":"babel src/ -d lib/","watch":"npm run build -- --watch","test:ci_all":"npm run test:ci_fixtures && npm run test:ci_browser","publish:next":"npm publish --tag=next","test:browser":"node tests/run-browser-tests.js","publish:latest":"npm publish","test:ci_browser":"npm run install:browser-tests && npm run test:browser","test:ci_fixtures":"npm run test","install:build-deps":"node build/install-build-deps.js","release:next:major":"npm --no-git-tag-version version premajor && npm run publish:next","release:next:minor":"npm --no-git-tag-version version preminor && npm run publish:next","release:next:patch":"npm --no-git-tag-version version prepatch && npm run publish:next","release:next:update":"npm --no-git-tag-version version prerelease && npm run publish:next","release:latest:major":"npm version major && npm run tag && npm run publish:latest","release:latest:minor":"npm version minor && npm run tag && npm run publish:latest","release:latest:patch":"npm version patch && npm run tag && npm run publish:latest","install:browser-tests":"node build/install-browser-tests.js"},"_npmUser":{"name":"nekr","email":"nekr.fabula@gmail.com"},"homepage":"https://github.com/NekR/offline-plugin","keywords":["webpack","plugin","offline","cache","caching","storage","service-worker","serviceworker","appcache","application cache","pwa","progressive web apps","app-shell","appshell"],"collective":{"url":"https://opencollective.com/offline-plugin","logo":"https://opencollective.com/offline-plugin/logo.txt?variant=binary&reverse=true","type":"opencollective"},"repository":{"url":"git+https://github.com/NekR/offline-plugin.git","type":"git"},"_npmVersion":"3.10.10","description":"offline-plugin for webpack","directories":{},"maintainers":[{"name":"nekr","email":"nekr.fabula@gmail.com"}],"_nodeVersion":"8.9.0","dependencies":{"ejs":"^2.3.4","slash":"^1.0.0","minimatch":"^3.0.3","deep-extend":"^0.4.0","loader-utils":"0.2.x"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"del":"^2.2.2","diff":"^3.0.1","glob":"^7.1.2","chalk":"^1.1.3","mocha":"^4.0.1","eslint":"^3.14.1","express":"^4.16.2","webpack":"4.1.0","dir-compare":"^1.1.0","cli-highlight":"^1.1.4","on-build-webpack":"^0.1.0","copy-webpack-plugin":"^4.2.0"},"buildDependencies":{"babel":"^5.8.23"},"_npmOperationalInternal":{"tmp":"tmp/offline-plugin_5.0.0-0_1520607662138_0.04271249659900245","host":"s3://npm-registry-packages"},"testsBrowserDependencies":{"puppeteer":"^1.1.1"},"_id":"offline-plugin@5.0.0-0","version":"5.0.0-0"}