Cloudflare Workers Starter Kit 项目教程

Cloudflare Workers Starter Kit 项目教程

cloudflare-starter-kit Template (boilerplate) repository for scaffolding Cloudflare Workers projects 项目地址: https://gitcode.com/gh_mirrors/cl/cloudflare-starter-kit

1. 项目的目录结构及介绍

Cloudflare Workers Starter Kit 项目的目录结构如下：

├── github/workflows  # CI/CD 工作流，由 GitHub Actions 驱动
├── vscode           # VSCode 设置，包括代码片段和推荐的扩展等
├── api              # 处理 API 请求的 Cloudflare Worker 脚本
├── app              # 由 Vite 和 React.js 驱动的 Web 应用程序前端
├── edge             # 用于提供静态网站的 Cloudflare Workers 脚本（反向代理）
├── scripts          # 自动化脚本，例如 yarn deploy
├── package.json     # NPM 依赖项列表和 Yarn 工作区
└── tsconfig.base.json # 跨包/工作区的 TypeScript 配置

目录结构介绍

• github/workflows: 包含 CI/CD 工作流的配置文件，这些工作流由 GitHub Actions 驱动。
• vscode: 包含 VSCode 的设置，包括代码片段、推荐的扩展等。
• api: 包含处理 API 请求的 Cloudflare Worker 脚本。
• app: 包含由 Vite 和 React.js 驱动的 Web 应用程序前端。
• edge: 包含用于提供静态网站的 Cloudflare Workers 脚本（反向代理）。
• scripts: 包含自动化脚本，例如 yarn deploy。
• package.json: 包含 NPM 依赖项列表和 Yarn 工作区。
• tsconfig.base.json: 包含跨包/工作区的 TypeScript 配置。

2. 项目的启动文件介绍

项目的启动文件主要位于 scripts 目录下，具体包括：

• yarn start: 启动 Web 应用程序，默认运行在 http://localhost:5173/。
• yarn lint: 使用 ESLint 验证代码。
• yarn tsc: 使用 TypeScript 编译器验证代码。
• yarn test: 使用 Vitest、Miniflare 和 Supertest 运行单元测试。
• yarn build: 编译并打包 Worker 脚本到 dist 文件夹。
• yarn deploy: 将应用程序部署到 Cloudflare Workers 或 GCF。

启动文件介绍

• yarn start: 启动开发服务器，用于本地开发和调试。
• yarn lint: 用于代码风格检查，确保代码符合项目规范。
• yarn tsc: 用于 TypeScript 代码的类型检查。
• yarn test: 用于运行单元测试，确保代码的正确性。
• yarn build: 用于构建生产环境的代码。
• yarn deploy: 用于将代码部署到 Cloudflare Workers 或 GCF。

3. 项目的配置文件介绍

项目的配置文件主要包括以下几个：

• package.json: 项目的依赖管理文件，包含项目的依赖项和脚本命令。
• tsconfig.base.json: TypeScript 的基础配置文件，定义了 TypeScript 编译器的全局配置。
• wrangler.toml: Cloudflare Workers 的部署配置文件，定义了 Worker 的名称、入口文件、兼容日期等。
• .env: 环境变量文件，用于存储开发、测试和生产环境的环境变量。

配置文件介绍

• package.json: 包含项目的依赖项和脚本命令，例如 start、lint、test 等。
• tsconfig.base.json: 定义了 TypeScript 编译器的全局配置，包括编译选项、模块解析等。
• wrangler.toml: 定义了 Cloudflare Workers 的部署配置，包括 Worker 的名称、入口文件、兼容日期等。
• .env: 存储开发、测试和生产环境的环境变量，例如 API 密钥、数据库连接字符串等。

通过以上配置文件，开发者可以轻松管理项目的依赖、编译选项、部署配置和环境变量，确保项目的顺利开发和部署。

cloudflare-starter-kit Template (boilerplate) repository for scaffolding Cloudflare Workers projects 项目地址: https://gitcode.com/gh_mirrors/cl/cloudflare-starter-kit