/assets-generator

Zero-config PWA Assets Generator

Primary LanguageTypeScriptMIT LicenseMIT

@vite-pwa/assets-generator - Zero-config PWA Assets Generator
Zero-config PWA Assets Generator

NPM version NPM Downloads Docs & Guides
GitHub stars


๐Ÿš€ Features

  • ๐Ÿ“– Documentation & guides
  • ๐Ÿ‘Œ 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
  • ๐Ÿ”Œ 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, SvelteKit, VitePress, Astro, and Nuxt 3
  • ๐Ÿ’ฅ PWA Assets Generator: generate all the PWA assets from a single command and a single source image

๐Ÿ“ฆ Install

# 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:

import { defineConfig, minimalPreset 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:

{
  "scripts": {
    "generate-pwa-assets": "pwa-assets-generator"
  }
}

Read the ๐Ÿ“– documentation 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.

๐Ÿ‘€ Full config

Check out the type declaration src/config.ts for more details.

๐Ÿ“„ License

MIT License ยฉ 2023-PRESENT Anthony Fu