Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vite-pwa/remix
Zero-config PWA Plugin for Remix
https://github.com/vite-pwa/remix
pwa remix vite vite-plugin workbox
Last synced: 4 days ago
JSON representation
Zero-config PWA Plugin for Remix
- Host: GitHub
- URL: https://github.com/vite-pwa/remix
- Owner: vite-pwa
- License: mit
- Created: 2024-03-21T23:23:25.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-09-04T19:08:29.000Z (4 months ago)
- Last Synced: 2024-12-15T03:06:46.065Z (11 days ago)
- Topics: pwa, remix, vite, vite-plugin, workbox
- Language: TypeScript
- Homepage: https://vite-pwa-org.netlify.app/frameworks/remix
- Size: 513 KB
- Stars: 60
- Watchers: 1
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
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 { defineConfig } from 'vite'
import { RemixVitePWA } from '@vite-pwa/remix'
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)