👋 Welcome to
expo-pwa

Generate PWA files for your project

---

🚀 Usage

You can use this package with npx or globally install:

``sh


npx

npx expo-pwa [options]

global

npm i -g expo-pwa
`

Optionally, you can install the sharp CLI globally before using this CLI for native image editing:

`sh
npm install -g sharp-cli
`

🤔 Why?

This package was created as a universal solution for creating PWA assets locally, with _optional_ native acceleration via Sharp CLI, falling back on Jimp for wider device compatibility. Internally the @expo/webpack-config uses this package to generate PWA compliant website for Expo projects. By splitting this logic out of the Webpack config, we can generate PWAs for Next.js and Gatsby projects as well!

> Image generation is not limited to Expo projects.

Usage In Expo

You can use this CLI to generate PWA assets manually and skip the Expo Webpack PWA generation step, effectively speeding up your production builds.

To do this, you'll need to first eject the web/index.html

`sh
expo customize:web


select the web/index.html option


`

Now you can run any of the PWA commands, for this example we'll generate favicons. Assuming you have an image at ./assets/icon.png, run the following command from the root project folder.

> Note: This also works for remote images!

`sh
expo-pwa favicon ./assets/icon.png
`

The images by default will be created in the Expo web static folder web/ (this can be changed using the --output flag). You should see the following output:

`sh
$ expo-pwa favicon ./assets/icon.png

› Copy the following lines into your HTML to link the new assets.




`

Simply copy the last few lines into the of your web/index.html. When you build your project with expo build:web, the new favicons will be copied over from the web/ folder, and Webpack will skip the Favicon generation step.

> If you don't use all of the links, the Webpack config will attempt to create the missing ones using the values specified in your Expo project config.

You can always disable all PWA generation with expo build:web --no-pwa.

Commands

For more info run:

`sh
expo-pwa --help

For command info, run expo-pwa --help

expo-pwa splash --help
`

| command | description |
| ---------- | ----------------------------------------------------- |
| icon | Generate the home screen icons for a PWA |
| favicon | Generate the favicons for a website |
| splash | Generate the Safari splash screens for a PWA |
| manifest` | Generate the PWA manifest from an Expo project config |

License

The Expo source code is made available under the MIT license. Some of the dependencies are licensed differently, with the BSD license, for example.

---

[abp]: https://docs.expo.dev/workflow/configuration/#assetbundlepatterns