Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/userquin/vite-pwa-nuxt-integration
https://github.com/userquin/vite-pwa-nuxt-integration
Last synced: 15 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/userquin/vite-pwa-nuxt-integration
- Owner: userquin
- License: mit
- Created: 2022-11-20T16:09:04.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2022-11-21T18:50:05.000Z (almost 2 years ago)
- Last Synced: 2024-10-15T00:02:34.278Z (about 1 month ago)
- Language: TypeScript
- Size: 187 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
Zero-config PWA Plugin for Nuxt 3
## 🚀 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
## 📦 Install
> Requires Vite 3.2.0+ and Nuxt 3.0.0+
```bash
npm i @vite-pwa/nuxt -D
# yarn
yarn add @vite-pwa/nuxt -D
# pnpm
pnpm add @vite-pwa/nuxt -D
```
## 🦄 Usage
Add `@vite-pwa/nuxt` module to `nuxt.config.ts` and configure it:
```ts
// nuxt.config.ts
import { defineNuxtConfig } from 'nuxt/config'
export default defineNuxtConfig({
modules: [
'@vite-pwa/nuxt'
],
pwa: {
/* PWA options */
}
})
```
Read the [📖 documentation](https://vite-pwa-org.netlify.app/frameworks/nuxt) for a complete guide on how to configure and use
this plugin.
## 👀 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 © 2022-PRESENT [Anthony Fu](https://github.com/antfu)