# expo-pwa
> Create PWA resources for Expo projects
Latest version **0.0.127** (published 2023-08-25) · MIT license · 0 weekly downloads
## Install
```sh
npm install expo-pwa
pnpm add expo-pwa
yarn add expo-pwa
bun add expo-pwa
```
Provides the command `expo-pwa`.
## Health
**Score 15/100 (F)** — status: abandoned.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support; pre 1.0.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 0.0.127 |
| Published | 2023-08-25 |
| First published | 2020-03-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 107.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2669 |
| Author | Expo |
| Maintainers | radoslawkrzemien, aleqsio, marklawlor, gabrieldonadel, simek, keith-kurak, christopherwalter, kbrandwijk, fiber-god, ide, brentvatne, evanbacon, quinlanj, expoadmin, tsapeta, exponent, wschurman, wkozyra, bycedric, lukmccall, jonsamp, princefleaswallow, kudochien, esamelson |
| Keywords | expo, pwa, react-native, react-native-web |
## Links
- npm: https://www.npmjs.com/package/expo-pwa
- Repository: https://github.com/expo/expo-cli
- Homepage: https://github.com/expo/expo-cli#readme
- Issues: https://github.com/expo/expo-cli/issues
- npm.io page: https://npm.io/package/expo-pwa
## Dependencies (4)
- [chalk](https://npm.io/package/chalk.md) ^4.0.0
- [commander](https://npm.io/package/commander.md) 2.20.0
- [update-check](https://npm.io/package/update-check.md) 1.5.3
- [@expo/image-utils](https://npm.io/package/@expo/image-utils.md) 0.3.23
## Recent versions
- 0.0.127 (latest) — 2023-08-25
- 0.0.67-alpha.0 (alpha) — 2021-03-03
- 0.0.126 — 2023-07-05
- 0.0.125 — 2023-05-30
- 0.0.124 — 2022-10-31
- 0.0.123 — 2022-08-12
- 0.0.122 — 2022-07-20
- 0.0.121 — 2022-07-11
- 0.0.120 — 2022-06-25
- 0.0.119 — 2022-05-13
- 0.0.118 — 2022-04-27
- 0.0.117 — 2022-04-27
- 0.0.116 — 2022-04-25
- 0.0.115 — 2022-04-11
- 0.0.114 — 2022-03-08
- … 122 more at https://npm.io/package/expo-pwa/versions
## README
👋 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.
