Web Push Codelab 项目启动与配置教程

1. 项目目录结构及介绍

Web Push Codelab 项目是一个用于学习如何实现 Web Push 功能的示例项目。项目的目录结构如下：

web-push-codelab/
├── index.html
├── manifest.json
├── service-worker.js
├── server/
│   ├── index.js
│   ├── push.js
│   └── node_modules/
└── public/
    ├── index.html
    ├── manifest.json
    └── service-worker.js

• index.html：网页的主页面，用户与之交互的界面。
• manifest.json：Web 应用的清单文件，定义了 Web 应用的基本信息，如启动图标、页面显示方向等。
• service-worker.js：服务工作者脚本，用于注册推送通知等功能。
• server/：服务端代码目录，包含 Node.js 服务器相关文件。
  • index.js：Node.js 服务器的入口文件。
  • push.js：用于处理推送通知逻辑的脚本。
  • node_modules/：Node.js 项目的依赖模块目录。
• public/：公共资源目录，存放前端代码和文件。
  • index.html：与根目录下的 index.html 相同，网页的主页面。
  • manifest.json：与根目录下的 manifest.json 相同，Web 应用清单文件。
  • service-worker.js：与根目录下的 service-worker.js 相同，服务工作者脚本。

2. 项目的启动文件介绍

项目的启动主要通过服务端 server/index.js 文件进行。

const express = require('express');
const webpush = require('web-push');
const path = require('path');

// ...此处省略了一些配置代码

const app = express();

app.use(express.static(path.join(__dirname, 'public')));

// ...此处省略了路由和中间件的设置代码

app.listen(3000, () => {
  console.log('Server is running on http://localhost:3000');
});

这段代码创建了一个 Express 应用，并且将静态文件（如 HTML、CSS 和 JavaScript 文件）托管在 public 目录下。应用监听 3000 端口，并在启动时在控制台输出一条消息。

3. 项目的配置文件介绍

项目的配置主要通过 manifest.json 文件进行。这是一个 JSON 格式的文件，定义了 Web 应用的基本属性。

{
  "name": "Web Push Codelab",
  "short_name": "Codelab",
  "start_url": "/index.html",
  "display": "standalone",
  "background_color": "#ffffff",
  "theme_color": "#000000",
  "icons": [
    {
      "src": "images/icon-192x192.png",
      "sizes": "192x192",
      "type": "image/png"
    },
    {
      "src": "images/icon-512x512.png",
      "sizes": "512x512",
      "type": "image/png"
    }
  ]
}

这个文件定义了应用的名称、简称、起始 URL、显示方式、背景颜色、主题颜色以及应用图标的路径和大小。这些信息用于在用户设备上安装 Web 应用时展示。