PWABuilder
The simplest way to create progressive web apps across platforms and devices.
This repo is home to several projects in the PWABuilder family of tools.
Tools
Docs
Components
Recommended Development setup
You will need the following things properly installed on your computer.
You should also be familiar with TypeScript which we use for this project. This helps give you more guidance as you code from intellisense when using VSCode.
We recommend the following tools for your dev setup:
Additionally, when you open the project in VS Code, you'll be prompted to install recommended extensions.
Development
Set the NODE_BIN environment variable, .vscode/launch.json for VS code and apps\pwabuilder\Properties\launchSettings.json for Visual Studio:
- Windows:
C:/Program Files/nodejs/node.exe
- Mac:
/usr/local/bin/node
- Linux:
/usr/bin/node
Using VS Code (App and API)
- Run
VSCode Run and Debug (F5 key) to build the project and start a local Edge browser.
- Closing the Edge browser will terminate the debug session.
Using Visual Studio (API only)
- Open the solution and run the
https profile (F5 key)
Alternatively, build the Dockerfile.production container and access it from http://localhost:8080
Deployment
The web app, Microsoft Store, and Google Play deployment workflows publish uniquely tagged
images containing the commit SHA, workflow run ID, and run attempt. The web app
and Google Play workflows deploy the digest captured from their pushed image.
Windows App Service misparses digest references, so the Microsoft Store workflow
deploys its unique tag after locking it in ACR against writes and deletion.
Locking must succeed before the build publishes its deployment output; the build
identity needs permission to update ACR image attributes.
Neither approach uses a mutable :production or :latest tag, preventing a
subsequent preview build from changing the image a slot pulls on restart or scale-out.
Promote the tested image by swapping slots or deploying its exact digest (the
locked unique tag for Windows). Existing production slots using mutable tags
must be pinned separately to their verified known-good image references;
changing these workflows does not update live slots.
Retain images referenced by deployed slots and images needed for rollback.
Locked Windows tags must be explicitly unlocked before intentional cleanup.
Breaking web app and Google Play API changes still require coordinated releases.
Windows staging and all PR slots must return HTTP 200 from their root URL within
30 minutes before deployment succeeds or PR links are published. Checks retry
warming-up responses and connection failures without accepting redirects.
On timeout, the workflow attempts to download platform logs and uploads them as
a startup diagnostics artifact retained for three days; it still fails if log
collection fails. No logging settings are changed.
Run the deployment regression checks with PowerShell 7:
pwsh -NoProfile -File .github/scripts/tests/test-windows-deployment.ps1,
pwsh -NoProfile -File .github/scripts/tests/test-webapp-readiness.ps1, and
pwsh -NoProfile -File .github/scripts/tests/test-pr-slot.ps1.
This is the beginning of the README. Read the rest at the original. Read the full README ↗
