Repository files navigation

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.

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

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 withTypeScript which we use for this project. This helps give you more guidance as you code fromintellisense when usingVSCode.

We recommend the following tools for your dev setup:

• Editor:VSCode
• Terminal:Windows Terminal orhyper

Additionally, when you open the project in VS Code, you'll be prompted to install recommended extensions.

Set theNODE_BIN environment variable,.vscode/launch.json for VS code andapps\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)

• RunVSCode 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 thehttps profile (F5 key)

Alternatively, build theDockerfile.production container and access it fromhttp://localhost:8080

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 theMicrosoft Open Source Code of Conduct. For more information see theCode of Conduct FAQ or contactopencode@microsoft.com with any additional questions or comments.