开始开发
贡献者快速入门
开始开发
本文档面向贡献者，介绍如何参与 amagi 的开发。
环境要求
- Node.js >= 22
- pnpm >= 9
快速开始
Fork 仓库
在 GitHub 上 Fork ikenxuan/amagi 到你的账号下。
克隆你的仓库
git clone https://github.com/你的用户名/amagi.git
cd amagi安装依赖
pnpm install开发模式
pnpm dev在 packages/core 下启动开发模式，监听文件变化。
pnpm docs:dev访问 http://localhost:3000 预览文档。
构建
pnpm build常用命令
| 命令 | 说明 |
|---|---|
pnpm install | 安装依赖 |
pnpm dev | 核心包开发模式 |
pnpm build | 构建所有包 |
pnpm typecheck | 类型检查 |
pnpm lint | 代码检查 |
pnpm fix | 自动修复代码风格 |
pnpm docs:dev | 文档站开发模式 |
pnpm docs:build | 构建文档站 |