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

Tools	Overview	Source	Docs	Contribute
PWABuilder.com	The best way to package PWAs for various stores.	/apps/pwabuilder	PWABuilder docs	Wiki
PWA Studio	PWA Studio makes VSCode the BEST developer environment for building Progressive Web Apps.	/apps/pwabuilder-vscode	PWA Studio docs	Wiki
PWA Starter	Our opinionated and production tested progressive web app (PWA) template for creating new projects.	Repo	PWA Starter docs	Wiki

Docs

Docs	Source	Contribute
docs.pwabuilder.com	/docs	Wiki
blog.pwabuilder.com	/apps/blog	/apps/blog

Components

Components	Overview	Source	Docs	Contribute
<pwa-install>	Web component for great PWA install experience	pwa-install	pwa-install	Wiki

Recommended Development setup

You will need the following things properly installed on your computer.

• Node.js
• NPM
• .NET 9.0 SDK
• Docker Desktop

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:

• Editor: VSCode
• Terminal: Windows Terminal or hyper

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

License

All files on the PWABuilder repository are subject to the MIT license. Please read the License file at the root of the project.

---

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.