create-pwa
create-pwa copied to clipboard
PWA Templates
PWA Templates
๐ 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, Nuxt 3 and 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
๐ฆ Usage
Since the package name begins with create-
, it is considered a project generator and can be run simply as @vite-pwa/pwa
.
This command launches an interactive questionnaire in the command line for configuring different parts of the project.
# npm
npm create @vite-pwa/pwa@latest
# yarn
yarn create @vite-pwa/pwa
# pnpm
pnpm create @vite-pwa/pwa
# bun
bun create @vite-pwa/pwa
Then follow the prompts!
Read the ๐ documentation for a complete guide on how to use it.
:clock1: Status
Our plan is to release the first version when all Vite templates are ready:
- [x]
VanillaJS
andTypeScript
templates - [x]
Vue
andVue + TypeScript
templates - [x]
Lit
andLit + TypeScript
templates - [x]
Svelte
andSvelte + TypeScript
templates - [x]
React
andReact + TypeScript
templates - [x]
Preact
andPreact + TypeScript
templates - [x]
SolidJS
andSolidJS + TypeScript
templates
Later we will add support for meta-frameworks:
- [x]
Nuxt 3
template (fromv0.1.0
) - [x]
SvelteKit
template (fromv0.2.0
) - [ ]
Astro
template - [x]
Remix
template (fromv0.3.0
) - [ ]
VitePress
template - [ ]
Qwik City
template
You can check the progress in the TODO file, previous task lists will be also updated.
If you want to contribute, read the CONTRIBUTING guide.
๐ License
MIT License ยฉ 2024-PRESENT Anthony Fu