开源项目 Glyph 使用教程

1. 项目目录结构及介绍

开源项目 Glyph 的目录结构如下：

glyph/
├── apps/                     # 应用程序目录
├── docs/                     # 文档目录
├── packages/                 # 包目录
├── patches/                  # 补丁目录
├── .github/                  # GitHub 相关配置
├── .husky/                   # Husky 配置目录
├── .vscode/                  # Visual Studio Code 配置
├── Dockerfile                # Docker 配置文件
├── Gemfile                   # Ruby 项目依赖配置文件
├── Gemfile.lock              # Ruby 项目依赖锁定文件
├── LICENSE                   # 项目许可证文件
├── README.md                 # 项目说明文件
├── cspell.config.json         # CSpell 配置文件
├── doppler.yaml              # Doppler 配置文件
├── eslint.config.js          # ESLint 配置文件
├── kubeconfig                # Kubernetes 配置文件
├── lint-staged.config.js      # Lint-staged 配置文件
├── package.json              # Node.js 项目配置文件
├── pnpm-lock.yaml            # pnpm 锁定文件
├── pnpm-workspace.yaml        # pnpm 工作空间配置文件
├── prettier.config.js         # Prettier 配置文件
├── syncpack.config.cjs       # Syncpack 配置文件
└── turbo.json                # Turborepo 配置文件

• apps/: 包含应用程序的代码。
• docs/: 存放项目文档。
• packages/: 存储项目中的包。
• patches/: 存储对第三方库的补丁。
• .github/: 存储 GitHub Actions 工作流和其他 GitHub 相关配置。
• .husky/: Husky 配置目录，用于管理 Git 钩子。
• .vscode/: Visual Studio Code 项目的配置文件。

2. 项目的启动文件介绍

项目的启动主要通过以下文件：

• Dockerfile: 用于构建项目的 Docker 容器镜像。
• package.json: Node.js 项目的配置文件，其中定义了项目的入口脚本和依赖。

启动项目的方式如下：

1. 使用 Docker：

docker-compose up

2. 直接在本地环境：

pnpm dev

3. 项目的配置文件介绍

项目的主要配置文件包括：

• /LICENSE: 项目的许可证文件，本项目采用 AGPL-3.0 许可。
• .editorconfig: 用于定义代码编辑器的配置，如缩进风格。
• .envrc: 使用 direnv 管理环境变量。
• .gitattributes: 用于定义 Git 的一些行为，如文件编码。
• .gitignore: 定义 Git 忽略的文件和目录。
• .npmrc: Node.js 的 npm 配置文件。
• Dockerfile: Docker 容器构建的配置文件。
• Gemfile 和 Gemfile.lock: Ruby 项目的依赖和依赖锁定的配置文件。
• pnpm-lock.yaml: pnpm 的依赖锁定文件。
• pnpm-workspace.yaml: 定义 pnpm 工作空间的配置。

通过了解这些配置文件，可以更好地管理和维护项目。