https://github.com/vite-pwa/assets-generator
Zero-config PWA Assets Generator
https://github.com/vite-pwa/assets-generator
generator icons pwa sharp sharp-ico
Last synced: about 1 month ago
JSON representation
Zero-config PWA Assets Generator
- Host: GitHub
- URL: https://github.com/vite-pwa/assets-generator
- Owner: vite-pwa
- License: mit
- Created: 2023-06-04T14:00:35.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-29T17:42:14.000Z (3 months ago)
- Last Synced: 2025-05-11T16:05:07.610Z (about 2 months ago)
- Topics: generator, icons, pwa, sharp, sharp-ico
- Language: TypeScript
- Homepage: https://vite-pwa-org.netlify.app/assets-generator/
- Size: 357 KB
- Stars: 130
- Watchers: 4
- Forks: 12
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
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)