AIPex 文档开发文档
使用 AIPex 构建 - API、贡献和架构
开发者资源
构建 AIPex 或为项目做贡献所需的一切。
贡献指南
学习如何为 AIPex 做贡献。我们欢迎错误报告、功能请求和拉取请求。
API 参考
为使用 AIPex 构建自定义自动化的开发者提供的完整 API 文档。
架构
了解 AIPex 的架构、设计决策和技术实现。
MCP 协议
了解支持 AIPex 工具的模型上下文协议（MCP）。
快速链接
开发入门
前置要求
- Node.js 18+ 和 pnpm
- Chrome/Chromium 浏览器
- TypeScript 和 React 基础知识
- 熟悉 Chrome 扩展 API
设置开发环境
克隆仓库
git clone https://github.com/AIPexStudio/AIPex.git
cd AIPex安装依赖
pnpm install启动开发服务器
pnpm dev在 Chrome 中加载扩展
- 打开
chrome://extensions/ - 启用"开发者模式"
- 点击"加载已解压的扩展程序"
- 选择
build/chrome-mv3-dev目录
项目结构
AIPex/
├── src/
│ ├── background/ # 后台服务工作者
│ ├── content/ # 内容脚本
│ ├── popup/ # 扩展弹出窗口 UI
│ ├── sidepanel/ # 侧边栏 UI
│ ├── tools/ # MCP 工具实现
│ └── utils/ # 共享工具
├── assets/ # 静态资源
├── .cursor/ # AI 开发的 Cursor 规则
└── package.json贡献
我们欢迎各种形式的贡献！以下是您可以提供帮助的方式：
贡献方式
报告错误
发现了错误？提交包含详细重现步骤的问题
建议功能
有想法？开始讨论以收集反馈
提交代码
通过拉取请求修复错误或实现功能
改进文档
帮助让我们的文档更好、更全面
贡献流程
- Fork 仓库
- 创建功能分支（
git checkout -b feature/amazing-feature） - 提交更改（
git commit -m 'Add amazing feature'） - 推送到分支（
git push origin feature/amazing-feature） - 打开拉取请求
代码指南
- 遵循 TypeScript 最佳实践
- 编写清晰、描述性的提交消息
- 为新功能添加测试
- 根据需要更新文档
- 遵循现有的代码风格
社区
加入我们不断壮大的社区，拥有 10K+ 用户和 573 GitHub stars！
参与其中
- ⭐ 在 GitHub 上给我们加星：表达您的支持
- 🍴 Fork 项目：构建您自己的版本
- 💬 加入讨论：分享想法并获得帮助
- 🐛 报告问题：帮助我们改进
- 📝 编写教程：分享您的知识
许可证
AIPex 采用 MIT 许可，完全免费使用、修改和分发。
MIT License
Copyright (c) 2025 AIPex Studio
特此免费授予任何获得本软件副本的人...