Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vite-pwa/astro
Zero-config PWA Integration for Astro
https://github.com/vite-pwa/astro
astro astro-integration pwa vite vite-plugin workbox
Last synced: 3 days ago
JSON representation
Zero-config PWA Integration for Astro
- Host: GitHub
- URL: https://github.com/vite-pwa/astro
- Owner: vite-pwa
- License: mit
- Created: 2022-09-10T12:07:38.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-18T14:27:52.000Z (13 days ago)
- Last Synced: 2024-12-21T19:03:48.251Z (10 days ago)
- Topics: astro, astro-integration, pwa, vite, vite-plugin, workbox
- Language: TypeScript
- Homepage: https://vite-pwa-org.netlify.app/frameworks/astro
- Size: 563 KB
- Stars: 202
- Watchers: 3
- Forks: 8
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
Zero-config PWA Integration for Astro
## 🚀 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.2.0, `@vite-pwa/astro` requires **Vite 5** and **Astro 4.0.0 or above**.
> Using any version older than v0.2.0 requires Vite 3.1.0+.
```bash
npm i @vite-pwa/astro -D
# yarn
yarn add @vite-pwa/astro -D
# pnpm
pnpm add @vite-pwa/astro -D
```
## 🦄 Usage
Add `@vite-pwa/astro` integration to `astro.config.mjs` and configure it:
```ts
// astro.config.mjs
import { defineConfig } from 'astro/config'
import AstroPWA from '@vite-pwa/astro'
// https://astro.build/config
export default defineConfig({
integrations: [AstroPWA()]
})
```
Read the [📖 documentation](https://vite-pwa-org.netlify.app/frameworks/astro) for a complete guide on how to configure and use
this plugin.
## ⚡️ Examples
You need to stop the dev server once started and then run `npm run build && npm run preview` to see the PWA in action.
Example
Source
Playground
Auto Update PWA
GitHub
Prompt for Update PWA
GitHub
## 👀 Full config
Check out 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)