Home

Awesome

<p align='center'> <img src='./hero.png' alt="@vite-pwa/astro - Zero-config PWA Integration for Astro"><br> Zero-config PWA Integration for Astro </p> <p align='center'> <a href='https://www.npmjs.com/package/@vite-pwa/astro' target="__blank"> <img src='https://img.shields.io/npm/v/@vite-pwa/astro?color=33A6B8&label=' alt="NPM version"> </a> <a href="https://www.npmjs.com/package/@vite-pwa/astro" target="__blank"> <img alt="NPM Downloads" src="https://img.shields.io/npm/dm/@vite-pwa/astro?color=476582&label="> </a> <a href="https://vite-pwa-org.netlify.app/frameworks/astro" target="__blank"> <img src="https://img.shields.io/static/v1?label=&message=docs%20%26%20guides&color=2e859c" alt="Docs & Guides"> </a> <br> <a href="https://github.com/vite-pwa/astro" target="__blank"> <img alt="GitHub stars" src="https://img.shields.io/github/stars/vite-pwa/astro?style=social"> </a> </p> <br> <p align="center"> <a href="https://cdn.jsdelivr.net/gh/antfu/static/sponsors.svg"> <img src='https://cdn.jsdelivr.net/gh/antfu/static/sponsors.svg'/> </a> </p>

๐Ÿš€ Features

๐Ÿ“ฆ 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+.

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:

// 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 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.

<table> <thead> <tr> <th>Example</th> <th>Source</th> <th>Playground</th> </tr> </thead> <tbody> <tr> <td><code>Auto Update PWA</code></td> <td><a href="https://github.com/vite-pwa/astro/tree/main/examples/pwa-simple">GitHub</a></td> <td> <a href="https://stackblitz.com/fork/github/vite-pwa/astro/tree/main/examples/pwa-simple" target="_blank" rel="noopener noreferrer"> <img src="https://developer.stackblitz.com/img/open_in_stackblitz.svg" alt="Open in StackBlitz" width="162" height="32"> </a> </td> </tr> <tr> <td><code>Prompt for Update PWA</code></td> <td><a href="https://github.com/vite-pwa/astro/tree/main/examples/pwa-prompt">GitHub</a></td> <td> <a href="https://stackblitz.com/fork/github/vite-pwa/astro/tree/main/examples/pwa-prompt" target="_blank" rel="noopener noreferrer"> <img src="https://developer.stackblitz.com/img/open_in_stackblitz.svg" alt="Open in StackBlitz" width="162" height="32"> </a> </td> </tr> </tbody> </table>

๐Ÿ‘€ Full config

Check out the following links for more details:

๐Ÿ“„ License

MIT License ยฉ 2022-PRESENT Anthony Fu