Skip to content

Commit 17494bb

Browse files
authored
Merge pull request #416 from chaitin/260309-docs-update-readme
docs: 优化 README 文档,简化内容并突出核心功能
2 parents cd3cbfe + 6e97848 commit 17494bb

File tree

1 file changed

+44
-4
lines changed

1 file changed

+44
-4
lines changed

README.md

Lines changed: 44 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,53 @@
11
# MonkeyCode
22

3-
MonkeyCode 是由长亭科技推出的企业级 AI 开发平台
3+
> 由长亭科技推出的企业级 AI 开发平台,覆盖需求 → 设计 → 开发 → 代码审查全流程
44
5-
## 目录结构
5+
## 简介
66

7-
- **[frontend](./frontend/)** - Web 前端(SaaS 版)
7+
MonkeyCode 是面向研发团队的企业级 AI 开发平台,通过自然语言交互,让 AI 帮你完成从需求分析、技术设计、代码开发到代码审查的完整开发流程。平台支持多种 AI 模型,集成 GitHub/GitLab/Gitee 等主流 Git 平台,提供在线 IDE、终端、文件管理等功能,大幅提升团队开发效率。
8+
9+
## 核心功能
10+
11+
### 智能任务
12+
用自然语言描述需求,AI 自动完成开发、设计或代码审查。支持从 Git 仓库或 ZIP 文件导入代码,可选择开发工具和 AI 模型。
13+
14+
### 项目管理
15+
关联 Git 仓库,管理项目需求和任务。可创建需求文档、启动设计任务和开发任务,实现需求驱动的开发流程。
16+
17+
### 在线开发环境
18+
提供完整的在线开发环境,包括:
19+
- **在线 IDE**:支持多语言高亮的代码编辑器
20+
- **终端**:支持多会话的 Web 终端
21+
- **文件管理**:在线浏览、编辑、上传下载文件
22+
- **在线预览**:一键预览 Web 服务
23+
- **远程协助**:支持与他人共享终端
24+
25+
### 代码审查
26+
配置 Git 机器人,自动审查 GitHub/GitLab/Gitee 的 PR/MR,提供智能代码改进建议。
27+
28+
### 团队协作
29+
企业管理员可以管理团队成员、分配资源(宿主机、镜像、AI 模型),实现权限控制和资源统一管理。
830

931
## 快速开始
1032

1133
```bash
12-
cd frontend && pnpm install && pnpm dev
34+
# 安装依赖
35+
cd frontend && pnpm install
36+
37+
# 启动开发服务器
38+
pnpm dev
39+
40+
# 构建生产版本
41+
pnpm build
1342
```
43+
44+
访问 http://localhost:5173 查看应用。
45+
46+
## 使用文档
47+
48+
详细的使用指南请参考 [frontend/doc.md](./frontend/doc.md)
49+
50+
## 联系我们
51+
52+
- 官网:https://monkeycode-ai.com
53+
- 帮助文档:https://monkeycode-ai.com/docs

0 commit comments

Comments
 (0)