Zero-config PWA Assets Generator
## ๐ 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
```bash
# npm
npm i @vite-pwa/assets-generator -D
# yarn
yarn add @vite-pwa/assets-generator -D
# pnpm
pnpm add @vite-pwa/assets-generator -D
```
## ๐ฆ Usage
Create `pwa-assets.config.js` or `pwa-assets.config.ts` file in your root project folder and configure a preset and the images to use to generate the PWA assets:
```ts
import { defineConfig, minimal2023Preset as preset } from '@vite-pwa/assets-generator/config'
export default defineConfig({
preset,
images: [
'public/logo.svg',
'public-dev/logo.svg'
]
})
```
then, add the following script to your `package.json` and run it:
```json
{
"scripts": {
"generate-pwa-assets": "pwa-assets-generator"
}
}
```
Read the [๐ documentation](https://vite-pwa-org.netlify.app/assets-generator) for a complete guide on how to configure and use
`@vite-pwa/assets-generator` CLI.
To use this library programmatically, check out the [API documentation](https://vite-pwa-org.netlify.app/assets-generator/api).
## ๐ Full config
Check out the type declaration [src/config.ts](./src/config.ts) for more details.
## ๐ License
[MIT](./LICENSE) License © 2023-PRESENT [Anthony Fu](https://github.com/antfu)