Pocket Monorepo 项目启动与配置教程

1. 项目目录结构及介绍

Pocket Monorepo 是一个基于 TypeScript 的单仓库多项目（Monorepo）结构，其中包含了 Pocket 应用程序的所有 TypeScript 系统服务，这些服务以微服务的形式部署。以下是项目的目录结构及介绍：

pocket-monorepo/
├── .docker/                # 存储 Docker 相关资源
├── .github/                # 存储 GitHub Actions 相关配置
├── .husky/                 # 存储 Husky 配置，用于 Git 钩子
├── .vscode/                # 存储 Visual Studio Code 配置
├── infrastructure/         # 存储 Terraform 基础设施配置
├── lambdas/                # 存储 Lambda 函数和 SQS 队列处理器
├── packages/               # 存储 TypeScript 配置和工具库
│   ├── eslint-config-custom/
│   ├── tsconfig/
│   ├── apollo-utils/
│   ├── ts-logger/
│   ├── tracing/
│   └── terraform-modules/
├── scripts/                # 存储 Node 脚本
├── servers/                # 存储 TypeScript 微服务
├── Dockerfile              # Docker 构建文件
├── LICENSE                 # Apache-2.0 许可证文件
├── README.md               # 项目说明文件
├── docker-compose.yml      # Docker Compose 配置文件
├── nodemon.json            # nodemon 配置文件
├── package.json            # npm 包配置文件
├── pnpm-lock.yaml          # pnpm 锁文件
├── pnpm-workspace.yaml      # pnpm 工作空间配置文件
├── renovate.json           # Renovate 配置文件
└── turbo.json              # TurboRepo 配置文件

2. 项目的启动文件介绍

项目的启动主要依赖于 package.json 中的脚本定义以及 Docker Compose 文件。

• package.json 中的 scripts 部分定义了启动开发环境、构建项目等脚本。例如，使用 pnpm dev 可以启动开发环境。

• docker-compose.yml 文件定义了服务启动时的 Docker 容器配置，包括 MySQL、Memcached、Redis 等共享服务。

3. 项目的配置文件介绍

项目的配置文件包括但不限于以下文件：

• .env.example：环境变量示例文件，用于本地开发时创建 .env 文件。

• tsconfig.json：TypeScript 配置文件，定义了项目的 TypeScript 编译选项。

• .prettierrc：Prettier 配置文件，用于代码格式化。

• .eslintrc：ESLint 配置文件，用于代码质量检查。

• turbo.json：TurboRepo 配置文件，用于优化构建和测试的缓存策略。

• renovate.json：Renovate 配置文件，用于自动化更新依赖。

启动项目前，需要将 .env.example 文件复制为 .env 并根据实际情况配置环境变量。使用 pnpm 命令可以触发 package.json 中定义的脚本，以启动项目或执行其他操作。