Skip to content

Commit

Permalink
fix: add generate-pwa-assets instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
langemike committed Feb 26, 2024
1 parent 8317c33 commit dad56b1
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion platforms/web/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,20 @@
- Lint through `yarn lint` (eslint, prettier, stylelint and tsc checks)
- Run `yarn start`

## Create favicons / pwa icons

First override the source icon with another image here [./public/images/icons/app-icon.png`](./public/images/icons/app-icon.png)
Use a high quality image square-sized image. We suggest a dimension 1024x1024 or higher

- Navigate to the platform directory `cd platforms/web`
- Perform `yarn generate-pwa-assets`

Instal `sharp` if you get the following error: Could not load the "sharp" module using the ... runtime.
And run `yarn generate-pwa-assets` afterwards

The different icon formats are defined here [pwa-assets.config.ts](./pwa-assets.config.ts)

## Developer guidelines

- Read the workspace guidelines here [../../docs/developer-guidelines.md](../../docs/developer-guidelines.md).
- Read the web platform guidelines here [./docs/developer-guidelines.md](./docs/developer-guidelines.md).

0 comments on commit dad56b1

Please sign in to comment.