remix

KO | EN

gitlite — search

#typescript #ai-agents #ai #dsh-plugin #deepseek-harness #open-source #cli #claude-code #codex #developer-tools #react #windows

★ 71 Open GitHub ↗

Zero-config PWA Plugin for Remix

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<p align='center'>
<img src='./hero.png' alt="@vite-pwa/remix - Zero-config PWA Plugin for Remix"><br>
Zero-config PWA Plugin for Remix
</p>

<br>

## 🚀 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.)

[//]: # (<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/remix/tree/main/examples/pwa-simple">GitHub</a></td>)

[//]: # (<td>)

[//]: # (<a href="https://stackblitz.com/fork/github/vite-pwa/remix/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/remix/tree/main/examples/pwa-prompt">GitHub</a></td>)

[//]: # (<td>)

[//]: # (<a href="https://stackblitz.com/fork/github/vite-pwa/remix/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:

- [Web app manifests](https://developer.mozilla.org/en-US/docs/Web/Manifest)
- [Workbox](https://developers.google.com/web/tools/workbox)

## 📄 License

remix

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README