Liam项目开发环境搭建与贡献指南-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00862/article/details/148549853

Liam项目开发环境搭建与贡献指南

Liam是一个现代化的开发项目，采用模块化架构设计，包含多个子包协同工作。项目使用pnpm作为包管理工具，采用monorepo结构管理多个功能模块。本文将详细介绍如何搭建开发环境以及如何为项目做出贡献。

在开始之前，请确保你的系统满足以下要求：

获取项目代码

使用Git克隆项目到本地开发目录。
安装依赖

执行以下命令启用corepack并安装项目依赖：
```
corepack enable
corepack prepare
pnpm install
```
配置环境变量

项目使用环境变量管理敏感信息和配置。根据你的身份选择配置方式：
- 核心维护人员：使用Vercel工具链链接项目并拉取环境变量：
```
pnpm vercel:link
pnpm vercel:env-pull
```
  然后创建.env.local文件并设置OPENAI_API_KEY和TRIGGER_SECRET_KEY等关键变量。
- 普通贡献者：复制环境模板文件并填写必要变量：
```
cp .env.template .env
```
  编辑.env文件，根据开发需要配置Supabase、GitHub App、Trigger.dev等服务凭证。
启动开发服务器

运行以下命令启动开发环境：
```
pnpm dev
```
访问各子包

项目包含多个子包，各自运行在不同的端口：

| 包名 | 访问地址 | |-------------------|----------------------| | @liam-hq/app | http://localhost:3001 | | @liam-hq/cli | http://localhost:5173 | | @liam-hq/docs | http://localhost:3002 | | @liam-hq/storybook| http://localhost:6006 |

当发现代码错误、文档问题或有新功能建议时，请遵循以下原则创建问题报告：

项目使用changeset管理包版本变更：

项目采用Gitmoji规范提交信息：

示例：

✨ 新增表格过滤功能
🐛 修复登录页面样式问题
📝 更新安装文档

提交前运行格式化命令：

pnpm run fmt

通过遵循这些指南，你可以高效地为Liam项目做出贡献，同时确保项目代码质量和一致性得到维护。

创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考