Zero-config PWA Plugin for Remix
## ๐ 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
`@vite-pwa/remix` requires **Vite 5** and **Remix 2.8.0 or above**.
```bash
npm i @vite-pwa/remix -D
# yarn
yarn add @vite-pwa/remix -D
# pnpm
pnpm add @vite-pwa/remix -D
```
## ๐ฆ Usage
Import the `@vite-pwa/remix` helper, create the Remix PWA Preset and the PWA Plugin and configure them in your Vite configuration file:
```ts
// vite.config.js
import { vitePlugin as remix } from '@remix-run/dev'
import { installGlobals } from '@remix-run/node'
import { RemixVitePWA } from '@vite-pwa/remix'
import { defineConfig } from 'vite'
installGlobals()
const { RemixVitePWAPlugin, RemixPWAPreset } = RemixVitePWA()
export default defineConfig({
plugins: [
remix({
presets: [RemixPWAPreset()],
}),
RemixVitePWAPlugin({
// PWA options
})
]
})
```
Read the [๐ documentation](https://vite-pwa-org.netlify.app/frameworks/remix) 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 © 2024-PRESENT [Anthony Fu](https://github.com/antfu)