Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/antfu/vite-plugin-pwa
Zero-config PWA for Vite
https://github.com/antfu/vite-plugin-pwa
preact pwa react solidjs svelte vite vite-plugin vue workbox
Last synced: about 1 month ago
JSON representation
Zero-config PWA for Vite
- Host: GitHub
- URL: https://github.com/antfu/vite-plugin-pwa
- Owner: vite-pwa
- License: mit
- Created: 2020-08-25T06:11:26.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-07-25T09:52:29.000Z (about 2 months ago)
- Last Synced: 2024-08-03T09:05:23.636Z (about 1 month ago)
- Topics: preact, pwa, react, solidjs, svelte, vite, vite-plugin, vue, workbox
- Language: TypeScript
- Homepage: https://vite-pwa-org.netlify.app/
- Size: 3.5 MB
- Stars: 2,987
- Watchers: 10
- Forks: 200
- Open Issues: 112
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- fucking-awesome-vite - vite-plugin-pwa - Zero-config PWA. (Plugins / Framework-agnostic Plugins)
- awesome-vite - vite-plugin-pwa - Zero-config PWA. (Plugins / Framework-agnostic Plugins)
- awesome-vite - `vite-plugin-pwa` - PWA (Pre-packed / Plugins)
README
Zero-config PWA Framework-agnostic Plugin for Vite
## 🚀 Features
- 📖 [**Documentation & guides**](https://vite-pwa-org.netlify.app/)
- 👌 **Zero-Config**: sensible built-in default configs for common use cases
- 🔩 **Extensible**: expose the full ability to customize the behavior of the plugin
- 🦾 **Type Strong**: written in [TypeScript](https://www.typescriptlang.org/)
- 🔌 **Offline Support**: generate service worker with offline support (via Workbox)
- ⚡ **Fully tree shakable**: auto inject Web App Manifest
- 💬 **Prompt for new content**: built-in support for Vanilla JavaScript, Vue 3, React, Svelte, SolidJS and Preact
- ⚙️ **Stale-while-revalidate**: automatic reload when new content is available
- ✨ **Static assets handling**: configure static assets for offline support
- 🐞 **Development Support**: debug your custom service worker logic as you develop your application
- 🛠️ **Versatile**: integration with meta frameworks: [îles](https://github.com/ElMassimo/iles), [SvelteKit](https://github.com/sveltejs/kit), [VitePress](https://github.com/vuejs/vitepress), [Astro](https://github.com/withastro/astro), [Nuxt 3](https://github.com/nuxt/nuxt) and [Remix](https://github.com/remix-run/remix)
- 💥 **PWA Assets Generator**: generate all the PWA assets from a single command and a single source image
- 🚀 **PWA Assets Integration**: serving, generating and injecting PWA Assets on the fly in your application
## 📦 Install
> From v0.17, `vite-plugin-pwa` requires **Vite 5**.
> From v0.16 `vite-plugin-pwa` requires **Node 16 or above**: `workbox v7` requires **Node 16 or above**.
> From v0.13, `vite-plugin-pwa` requires **Vite 3.1 or above**.
```bash
npm i vite-plugin-pwa -D
# yarn
yarn add vite-plugin-pwa -D
# pnpm
pnpm add vite-plugin-pwa -D
```
## 🦄 Usage
Add `VitePWA` plugin to `vite.config.js / vite.config.ts` and configure it:
```ts
// vite.config.js / vite.config.ts
import { VitePWA } from 'vite-plugin-pwa'
export default {
plugins: [
VitePWA()
]
}
```
Read the [📖 documentation](https://vite-pwa-org.netlify.app/guide/) for a complete guide on how to configure and use
this plugin.
Check out the client type declarations [client.d.ts](./client.d.ts) for built-in frameworks support.
## 👀 Full config
Check out the type declaration [src/types.ts](./src/types.ts) and the following links for more details.
- [Web app manifests](https://developer.mozilla.org/en-US/docs/Web/Manifest)
- [Workbox](https://developers.google.com/web/tools/workbox)
## 📄 License
[MIT](./LICENSE) License © 2020-PRESENT [Anthony Fu](https://github.com/antfu)