Wombat Dressing Room 项目启动与配置教程

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

Wombat Dressing Room 是一个由 Google Cloud Platform 提供的开源项目，旨在减少 npm 发布的攻击面。以下是项目的目录结构及各部分的介绍：

.
├── .github/
│   ├── config/
│   └── docs/
├── .gcloudignore
├── .gitignore
├── CHANGELOG.md
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── app-external.yaml
├── app-internal.yaml
├── index.yaml
├── package-lock.json
├── package.json
├── renovate.json
└── packages/

• .github/: 包含 GitHub 工作流的配置文件。
• .gcloudignore: 指定部署到 Google Cloud Platform 时应忽略的文件。
• .gitignore: 指定 Git 应忽略的文件。
• CHANGELOG.md: 记录项目的更新、修改和改进历史。
• CODE_OF_CONDUCT.md: 项目的行为准则。
• CONTRIBUTING.md: 指导贡献者如何参与项目。
• LICENSE: 项目的 Apache-2.0 许可证。
• README.md: 项目的简介、功能和使用说明。
• app-external.yaml: 外部服务的配置文件。
• app-internal.yaml: 内部服务的配置文件。
• index.yaml: 索引服务的配置文件。
• package-lock.json: 项目的依赖锁定文件。
• package.json: 项目的元数据、依赖和脚本。
• renovate.json: 依赖自动更新的配置文件。
• packages/: 包含项目相关的 npm 包。

2. 项目的启动文件介绍

项目的启动主要是通过 package.json 文件中的脚本实现的。以下是一些关键的启动脚本：

• npm run develop: 在本地开发环境中启动服务。
• npm run deploy: 部署应用到 Google Cloud Platform。

package.json 中的 scripts 部分：

"scripts": {
  "develop": "node scripts/develop.js",
  "deploy": "node scripts/deploy.js"
}

3. 项目的配置文件介绍

项目的配置文件主要包括 .env 文件以及 config/ 目录下的环境配置文件。

• .env: 用于本地开发环境的配置文件，包含所有必要的环境变量。
• config/external.env: 用于外部服务的环境配置文件。
• config/internal.env: 用于内部服务的环境配置文件。

以下是配置文件中可能包含的一些环境变量：

• NPM_OTP_SECRET: OTP 秘钥，用于 npm 账户的双因素认证。
• NPM_TOKEN: npm 账户的访问令牌。
• GITHUB_CLIENT_ID: GitHub OAuth 应用的客户端 ID。
• GITHUB_CLIENT_SECRET: GitHub OAuth 应用的客户端密钥。
• DATASTORE_PROJECT_ID: 配置的数据存储项目 ID。
• LOGIN_URL: 登录服务的 URL。
• REGISTRY_URL: 注册表的 URL。

确保在部署和开发之前正确配置这些环境变量，以使服务能够正常工作。