Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vite-pwa/sveltekit
Zero-config PWA Plugin for SvelteKit
https://github.com/vite-pwa/sveltekit
pwa sveltekit vite vite-plugin workbox
Last synced: 4 days ago
JSON representation
Zero-config PWA Plugin for SvelteKit
- Host: GitHub
- URL: https://github.com/vite-pwa/sveltekit
- Owner: vite-pwa
- License: mit
- Created: 2022-09-07T17:01:16.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-04T19:21:39.000Z (2 months ago)
- Last Synced: 2024-10-18T20:29:39.279Z (16 days ago)
- Topics: pwa, sveltekit, vite, vite-plugin, workbox
- Language: TypeScript
- Homepage: https://vite-pwa-org.netlify.app/frameworks/sveltekit
- Size: 1 MB
- Stars: 309
- Watchers: 3
- Forks: 15
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
Zero-config PWA Plugin for SvelteKit
## 🚀 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.3.0, `@vite-pwa/sveltekit` supports SvelteKit 2 (should also support SvelteKit 1).
> From v0.2.0, `@vite-pwa/sveltekit` requires **SvelteKit 1.3.1 or above**.
```bash
npm i @vite-pwa/sveltekit -D
# yarn
yarn add @vite-pwa/sveltekit -D
# pnpm
pnpm add @vite-pwa/sveltekit -D
```
## 🦄 Usage
Add `SvelteKitPWA` plugin to `vite.config.js / vite.config.ts` and configure it:
```ts
// vite.config.js / vite.config.ts
import { sveltekit } from '@sveltejs/kit/vite'
import { SvelteKitPWA } from '@vite-pwa/sveltekit'
export default {
plugins: [
sveltekit(),
SvelteKitPWA()
]
}
```
Read the [📖 documentation](https://vite-pwa-org.netlify.app/frameworks/sveltekit) 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) License © 2022-PRESENT [Anthony Fu](https://github.com/antfu)