felixicaza / assets-generator Goto Github PK

Zero-config PWA Assets Generator

• 📖 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

# npm 
npm i @vite-pwa/assets-generator -D 

# yarn 
yarn add @vite-pwa/assets-generator -D

# pnpm 
pnpm add @vite-pwa/assets-generator -D

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.

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

MIT License © 2023-PRESENT Anthony Fu