PWABuilder

跨平台和设备创建渐进式Web应用的最简单方法。

这个仓库是PWABuilder工具系列的多个项目的家园。

工具

文档

组件

组件	概述	源码	文档	贡献
<pwa-install>	用于优秀PWA安装体验的Web组件	pwa-install	pwa-install	Wiki

推荐的开发设置

您需要在计算机上正确安装以下内容：

• Node.js
• NPM

您还应该熟悉我们在此项目中使用的TypeScript。当使用VSCode时，这有助于通过智能感知为您提供更多编码指导。

我们为您的开发环境推荐以下工具：

• 编辑器：VSCode
• 终端：Windows Terminal或hyper

此外，当您在VS Code中打开项目时，系统会提示您安装推荐的扩展。

开发

导航到您计划工作的项目文件夹（例如/apps/pwabuilder），并按照README中的说明开始。

在项目文件夹中运行npm install将自动安装和构建所有依赖项。

关于这个单一代码仓库

这个单一代码仓库不像您可能习惯的其他单一代码仓库那样使用根package.json。相反，项目存在于各自的文件夹中，并且大多是相互独立的。

然而，当项目之间存在依赖关系时，我们的工具应该在您在项目根目录运行npm install时自动处理链接和依赖项构建。

例如，/apps/pwabuilder依赖于library/site-analytics。这个依赖关系在pwabuilder的package.json中定义如下：

  //package.json
  "dependencies": {
    "@pwabuilder/site-analytics": "file:../../libraries/site-analytics",
    ...

在pwabuilder文件夹中运行npm install也会为site-analytics项目运行npm install和npm run build。在大多数情况下，除非正在处理依赖项，否则开发人员不必担心这些项目如何链接。

为了使项目自动链接正常工作，请确保每个项目都有一个preinstall脚本，如下所示：

  // package.json
  "scripts": {
    "preinstall": "node ../../scripts/setupDeps.js",
    ...

许可证

PWABuilder仓库中的所有文件均受MIT许可证约束。请阅读项目根目录中的许可证文件。

本项目采用了Microsoft开源行为准则。有关更多信息，请参阅行为准则常见问题解答或联系opencode@microsoft.com咨询任何其他问题或意见。