{"id":19006527,"url":"https://github.com/vite-pwa/assets-generator","last_synced_at":"2025-05-16T00:09:13.024Z","repository":{"id":172797472,"uuid":"649325731","full_name":"vite-pwa/assets-generator","owner":"vite-pwa","description":"Zero-config PWA Assets Generator","archived":false,"fork":false,"pushed_at":"2025-03-29T17:42:14.000Z","size":366,"stargazers_count":130,"open_issues_count":17,"forks_count":12,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-05-11T16:05:07.610Z","etag":null,"topics":["generator","icons","pwa","sharp","sharp-ico"],"latest_commit_sha":null,"homepage":"https://vite-pwa-org.netlify.app/assets-generator/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vite-pwa.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"antfu","open_collective":"antfu"}},"created_at":"2023-06-04T14:00:35.000Z","updated_at":"2025-05-06T02:56:46.000Z","dependencies_parsed_at":"2023-11-16T22:53:22.287Z","dependency_job_id":"11f343ee-c775-4889-8e67-8886845593df","html_url":"https://github.com/vite-pwa/assets-generator","commit_stats":null,"previous_names":["vite-pwa/assets-generator"],"tags_count":19,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vite-pwa%2Fassets-generator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vite-pwa%2Fassets-generator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vite-pwa%2Fassets-generator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vite-pwa%2Fassets-generator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vite-pwa","download_url":"https://codeload.github.com/vite-pwa/assets-generator/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254442856,"owners_count":22071878,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["generator","icons","pwa","sharp","sharp-ico"],"created_at":"2024-11-08T18:32:54.050Z","updated_at":"2025-05-16T00:09:08.011Z","avatar_url":"https://github.com/vite-pwa.png","language":"TypeScript","funding_links":["https://github.com/sponsors/antfu","https://opencollective.com/antfu"],"categories":[],"sub_categories":[],"readme":"\u003cp align='center'\u003e\n\u003cimg src='./hero.svg' alt=\"@vite-pwa/assets-generator - Zero-config PWA Assets Generator\"\u003e\u003cbr\u003e\nZero-config PWA Assets Generator\n\u003c/p\u003e\n\n\u003cp align='center'\u003e\n\u003ca href='https://www.npmjs.com/package/@vite-pwa/assets-generator' target=\"__blank\"\u003e\n\u003cimg src='https://img.shields.io/npm/v/@vite-pwa/assets-generator?color=33A6B8\u0026label=' alt=\"NPM version\"\u003e\n\u003c/a\u003e\n\u003ca href=\"https://www.npmjs.com/package/@vite-pwa/assets-generator\" target=\"__blank\"\u003e\n    \u003cimg alt=\"NPM Downloads\" src=\"https://img.shields.io/npm/dm/@vite-pwa/assets-generator?color=476582\u0026label=\"\u003e\n\u003c/a\u003e\n\u003ca href=\"https://vite-pwa-org.netlify.app/assets-generator\" target=\"__blank\"\u003e\n    \u003cimg src=\"https://img.shields.io/static/v1?label=\u0026message=docs%20%26%20guides\u0026color=2e859c\" alt=\"Docs \u0026 Guides\"\u003e\n\u003c/a\u003e\n\u003cbr\u003e\n\u003ca href=\"https://github.com/vite-pwa/assets-generator\" target=\"__blank\"\u003e\n\u003cimg alt=\"GitHub stars\" src=\"https://img.shields.io/github/stars/vite-pwa/assets-generator?style=social\"\u003e\n\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cbr\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://cdn.jsdelivr.net/gh/antfu/static/sponsors.svg\"\u003e\n    \u003cimg src='https://cdn.jsdelivr.net/gh/antfu/static/sponsors.svg'/\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n## 🚀 Features\n\n- 📖 [**Documentation \u0026 guides**](https://vite-pwa-org.netlify.app/)\n- 👌 **Zero-Config**: sensible built-in default configs for common use cases\n- 🔩 **Extensible**: expose the full ability to customize the behavior of the plugin\n- 🦾 **Type Strong**: written in [TypeScript](https://www.typescriptlang.org/)\n- 🔌 **Offline Support**: generate service worker with offline support (via Workbox)\n- ⚡ **Fully tree shakable**: auto inject Web App Manifest\n- 💬 **Prompt for new content**: built-in support for Vanilla JavaScript, Vue 3, React, Svelte, SolidJS and Preact\n- ⚙️ **Stale-while-revalidate**: automatic reload when new content is available\n- ✨ **Static assets handling**: configure static assets for offline support\n- 🐞 **Development Support**: debug your custom service worker logic as you develop your application\n- 🛠️ **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)\n- 💥 **PWA Assets Generator**: generate all the PWA assets from a single command and a single source image\n- 🚀 **PWA Assets Integration**: serving, generating and injecting PWA Assets on the fly in your application\n\n## 📦 Install\n\n```bash\n# npm\nnpm i @vite-pwa/assets-generator -D\n\n# yarn\nyarn add @vite-pwa/assets-generator -D\n\n# pnpm\npnpm add @vite-pwa/assets-generator -D\n```\n\n## 🦄 Usage\n\nCreate `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:\n\n```ts\nimport { defineConfig, minimal2023Preset as preset } from '@vite-pwa/assets-generator/config'\n\nexport default defineConfig({\n  preset,\n  images: [\n    'public/logo.svg',\n    'public-dev/logo.svg'\n  ]\n})\n```\n\nthen, add the following script to your `package.json` and run it:\n\n```json\n{\n  \"scripts\": {\n    \"generate-pwa-assets\": \"pwa-assets-generator\"\n  }\n}\n```\n\nRead the [📖 documentation](https://vite-pwa-org.netlify.app/assets-generator) for a complete guide on how to configure and use\n`@vite-pwa/assets-generator` CLI.\n\nTo use this library programmatically, check out the [API documentation](https://vite-pwa-org.netlify.app/assets-generator/api).\n\n## 👀 Full config\n\nCheck out the type declaration [src/config.ts](./src/config.ts) for more details.\n\n## 📄 License\n\n[MIT](./LICENSE) License \u0026copy; 2023-PRESENT [Anthony Fu](https://github.com/antfu)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvite-pwa%2Fassets-generator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvite-pwa%2Fassets-generator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvite-pwa%2Fassets-generator/lists"}