Pocket Monorepo 项目启动与配置教程

Pocket Monorepo 项目启动与配置教程

pocket-monorepo Monorepo of all Pocket App Typescript Backend Sevices 项目地址: https://gitcode.com/gh_mirrors/po/pocket-monorepo

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

Pocket Monorepo 是一个使用 TypeScript 构建的 monorepo 项目，它包含了 Pocket 应用程序的所有 TypeScript 系统代码，并以微服务的形式部署。以下是项目的目录结构及其介绍：

pocket-monorepo/
├── .docker/                    # 包含 Docker 相关资源
│   ├── aws-resources/
│   ├── mysql-8-resources/
│   └── postgres-resources/
├── .github/                    # GitHub Actions 配置文件
├── .husky/                     # Husky 配置文件，用于 Git 钩子
├── .vscode/                    # VSCode 配置文件
├── infrastructure/             # Terraform 基础设施配置
├── lambdas/                    # Lambda 函数和 SQS 队列处理器
├── packages/                   # 共享的 TypeScript 包和配置
│   ├── eslint-config-custom/
│   ├── tsconfig/
│   ├── apollo-utils/
│   ├── ts-logger/
│   ├── tracing/
│   └── terraform-modules/
├── scripts/                    # 脚本文件
├── servers/                    # TypeScript 微服务
├── docker-compose.yml          # Docker Compose 配置文件
├── Dockerfile                  # Docker 构建文件
├── package.json                # npm 包配置文件
├── pnpm-lock.yaml              # pnpm 锁文件
├── pnpm-workspace.yaml         # pnpm 工作空间配置文件
├── renovate.json               # Renovate 配置文件
├── turbo.json                  # Turborepo 配置文件
└── README.md                   # 项目说明文件

2. 项目的启动文件介绍

项目的启动文件主要包括以下几个部分：

• docker-compose.yml：定义了项目中使用的 Docker 服务，如 MySQL、Memcached、Redis 以及各个微服务的启动配置。
• Dockerfile：定义了如何构建项目的 Docker 镜像。
• package.json：定义了项目的依赖、脚本和命令。

启动项目的基本步骤如下：

1. 将 .env.example 文件复制为 .env 文件，并根据实际情况进行配置。
2. 在项目根目录下执行 docker compose up --wait 命令启动 Docker 服务。
3. 执行 pnpm install 命令安装项目依赖。
4. 执行 pnpm dev 命令启动开发模式。

3. 项目的配置文件介绍

项目的配置文件包括以下内容：

• .env.example：项目环境变量的示例文件，用于配置数据库连接、API 密钥等信息。
• .dockerignore：Docker 构建时排除的文件列表。
• .gitignore：Git 忽略的文件列表。
• .prettierrc：Prettier 的配置文件，用于代码格式化。
• . prettierrcignore：Prettier 忽略的文件列表。
• tsconfig.json：TypeScript 的配置文件，定义了编译选项和包含/排除的文件。
• turbo.json：Turborepo 的配置文件，用于设置缓存策略和其他相关配置。

配置项目时，需要根据实际环境修改 .env.example 文件，并确保所有配置项正确无误。其他配置文件通常不需要修改，除非有特殊需求。

pocket-monorepo Monorepo of all Pocket App Typescript Backend Sevices 项目地址: https://gitcode.com/gh_mirrors/po/pocket-monorepo