Skip to content

Commit 9003abb

Browse files
committed
chore: update README.md
1 parent baf6e86 commit 9003abb

2 files changed

Lines changed: 641 additions & 106 deletions

File tree

README.md

Lines changed: 220 additions & 106 deletions
Original file line numberDiff line numberDiff line change
@@ -1,170 +1,284 @@
1-
# 🌟 CloudBase TurboDeploy AI开发套件
1+
![](https://tcb-advanced-a656fc-1257967285.tcloudbaseapp.com/mcp/mcp-github-banner.png)
2+
3+
# 🌟 CloudBase AI-Deploy MCP
24

35
**——用AI说话,10分钟搞定全栈应用!**
46

5-
## 🧐 这是什么?
7+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
8+
[![npm version](https://badge.fury.io/js/%40cloudbase%2Fcloudbase-mcp.svg)](https://badge.fury.io/js/%40cloudbase%2Fcloudbase-mcp)
69

7-
它是 AI IDE 和编程助手的的**最佳排档**
10+
当你在**Cursor/ VSCode GitHub Copilot/WinSurf/CodeBuddy**等AI编程工具里写代码时,它能自动帮你生成可直接部署的前后端应用+小程序,并一键发布到腾讯云开发 CloudBase。
811

9-
当你在**Cursor/GitHub Copilot/WinSurf/CodeBuddy**等AI编程工具里写代码时,它能自动帮你:
10-
- 1️⃣ **生成**可直接部署的前后端应用+小程序
11-
- 2️⃣ **一键发布**到腾讯云开发 CloudBase
12-
- 3️⃣ **智能修复**线上问题
12+
## 🚀 快速开始
1313

14-
全程不用碰服务器,像搭积木一样简单!
14+
### 1. 使用模板创建项目
1515

16-
## 🚀 三大核心能力
16+
选择适合你的项目模板快速开始:
1717

18-
| 模块 | 功能 | 小白理解 |
19-
| --------------------- | ------------------- | ------------------------- |
20-
| **云开发 CloudBase AI规则** | 为Cursor等IDE定制代码生成规则 | 教AI按腾讯云开发 CloudBase的标准写代码 |
21-
| **云开发 CloudBaseMCP** | 自动部署/监控/管理资源 | 你的云端"自动驾驶系统" |
22-
| **云开发 CloudBase 平台** | 前后端+数据库一体化托管 | 全栈应用的"集装箱" |
18+
```bash
19+
# Web 应用模板
20+
git clone https://github.com/TencentCloudBase/cloudbase-templates/web-starter
21+
cd web-starter
2322

24-
## 🔄 工作流程图
23+
# 小程序模板
24+
git clone https://github.com/TencentCloudBase/cloudbase-templates/miniprogram-starter
25+
cd miniprogram-starter
2526

26-
```mermaid
27-
graph TD
28-
A[用户] --> B{ Cursor等 AI IDE}
29-
B -->|调用| C[云开发CloudBase AI规则库]
30-
C --> D[前后端应用代码]
31-
B -->|触发| E[云开发CloudBase MCP]
32-
E --> F{自动检测}
33-
F -->|正常| G[部署到 云开发CloudBase平台]
34-
F -->|报错| H[返回日志给AI]
35-
H --> I[AI修正代码]
36-
I --> E
37-
G --> J[在线全栈应用]
38-
J --> K((小程序/Web/API))
27+
# 全栈模板
28+
git clone https://github.com/TencentCloudBase/cloudbase-templates/fullstack-starter
29+
cd fullstack-starter
3930
```
4031

41-
## 💡 典型使用场景
32+
### 2. 配置你的 AI IDE
4233

43-
**案例1:快速上线双人在线对战五子棋网站**
34+
<details>
35+
<summary><strong>🔧 Cursor 配置</strong></summary>
4436

45-
![](https://7463-tcb-advanced-a656fc-1257967285.tcb.qcloud.la/turbo-deploy/turbo-deploy-004.png)
37+
#### 步骤1:配置 MCP
38+
在 Cursor 设置中添加 MCP 配置:
4639

47-
1. 在Cursor输入:"做个双人在线对战五子棋网站,支持联机对战"
48-
2. AI自动生成:web 应用 + 云开发数据库API + 云函数+ websocket 实时推送
49-
3. 自动部署前后端资源,并得到现网可访问地址
50-
4. 用户可持续和 AI 互动不断增加功能,并部署
51-
5. 遇到问题后,可以把问题交给 AI 让 AI 查询云函数日志并解决,然后进行部署
40+
```json
41+
{
42+
"mcpServers": {
43+
"cloudbase-mcp": {
44+
"command": "npx",
45+
"args": ["@cloudbase/cloudbase-mcp"],
46+
"env": {
47+
"TENCENTCLOUD_SECRETID": "你的腾讯云SecretId",
48+
"TENCENTCLOUD_SECRETKEY": "你的腾讯云SecretKey",
49+
"CLOUDBASE_ENV_ID": "你的云开发环境ID"
50+
}
51+
}
52+
}
53+
}
54+
```
5255

53-
### 开发示例
56+
#### 步骤2:添加 AI 规则
57+
模板中已包含 `.cursor/rules/` 目录,AI 会自动识别云开发最佳实践。
5458

55-
![](https://7463-tcb-advanced-a656fc-1257967285.tcb.qcloud.la/turbo-deploy/turbo-deploy-001.png)
59+
</details>
5660

57-
![](https://7463-tcb-advanced-a656fc-1257967285.tcb.qcloud.la/turbo-deploy/turbo-deploy-002.png)
61+
<details>
62+
<summary><strong>🌊 WindSurf 配置</strong></summary>
5863

59-
### 应用体验
64+
#### 步骤1:配置 MCP
65+
在 WindSurf 设置中添加:
6066

61-
👉 点击访问 [生成产物访问地址](https://cloud1-5g39elugeec5ba0f-1300855855.tcloudbaseapp.com/gobang/#/)
67+
```json
68+
{
69+
"mcpServers": {
70+
"cloudbase-mcp": {
71+
"command": "npx",
72+
"args": ["@cloudbase/cloudbase-mcp"],
73+
"env": {
74+
"TENCENTCLOUD_SECRETID": "你的腾讯云SecretId",
75+
"TENCENTCLOUD_SECRETKEY": "你的腾讯云SecretKey",
76+
"CLOUDBASE_ENV_ID": "你的云开发环境ID"
77+
}
78+
}
79+
}
80+
}
81+
```
6282

83+
#### 步骤2:AI 规则配置
84+
模板中的 `.windsurf/` 目录包含专为 WindSurf 优化的配置。
6385

86+
</details>
6487

65-
**案例2:快速上线一个有 AI功能的宠物小程序**
88+
<details>
89+
<summary><strong>🤖 CLINE 配置</strong></summary>
6690

67-
![](https://7463-tcb-advanced-a656fc-1257967285.tcb.qcloud.la/turbo-deploy/turbo-deploy-005.png)
91+
#### MCP 配置
92+
```json
93+
{
94+
"mcpServers": {
95+
"cloudbase-mcp": {
96+
"command": "npx",
97+
"args": ["@cloudbase/cloudbase-mcp"],
98+
"env": {
99+
"TENCENTCLOUD_SECRETID": "你的腾讯云SecretId",
100+
"TENCENTCLOUD_SECRETKEY": "你的腾讯云SecretKey",
101+
"CLOUDBASE_ENV_ID": "你的云开发环境ID"
102+
}
103+
}
104+
}
105+
}
106+
```
68107

69-
1. 在Cursor输入:"开发一个宠物小精灵的养成小程序游戏,使用 AI 来增强角色的互动等玩法
70-
支持每个用户领养自己的小精灵"
71-
2. AI自动生成:小程序 + 云开发数据库API + 云函数
72-
3. 自动部署云函数,数据库等云开发资源
73-
4. 导入到微信 IDE 后,发布小程序即可获得生产环境小程序
74-
5. 用户可持续修改和完善新功能
108+
使用模板中的 `.clinerules/` 目录配置。
75109

76-
### 开发示例
110+
</details>
77111

78-
![](https://7463-tcb-advanced-a656fc-1257967285.tcb.qcloud.la/turbo-deploy/turbo-deploy-003.png)
112+
<details>
113+
<summary><strong>👥 CodeBuddy 配置</strong></summary>
79114

115+
#### 配置说明
116+
CodeBuddy 需要手动添加规则文件:
80117

118+
1. 使用模板中的 `.common_rules/` 目录
119+
2. 在对话时使用 `@` 选择相应的云开发规则
120+
3. MCP 配置同其他工具
81121

82-
### 应用体验
122+
</details>
83123

84-
小程序体验二维码
124+
<details>
125+
<summary><strong>🐙 GitHub Copilot 配置</strong></summary>
85126

86-
![](https://7463-tcb-advanced-a656fc-1257967285.tcb.qcloud.la/turbo-deploy/turbo-deploy-008.png)
127+
#### GitHub Copilot Chat 配置
128+
模板中的 `.github/` 目录包含 Copilot 优化配置。
87129

130+
> 注意:GitHub Copilot 目前不支持 MCP,部分自动部署功能需要手动执行。
88131
89-
![](https://7463-tcb-advanced-a656fc-1257967285.tcb.qcloud.la/turbo-deploy/turbo-deploy-006.png)
132+
</details>
90133

91-
![](https://7463-tcb-advanced-a656fc-1257967285.tcb.qcloud.la/turbo-deploy/turbo-deploy-007.png)
134+
<details>
135+
<summary><strong>🎯 Trae 配置</strong></summary>
92136

137+
#### 配置步骤
138+
```json
139+
{
140+
"mcpServers": {
141+
"cloudbase-mcp": {
142+
"command": "npx",
143+
"args": ["@cloudbase/cloudbase-mcp"],
144+
"env": {
145+
"TENCENTCLOUD_SECRETID": "你的腾讯云SecretId",
146+
"TENCENTCLOUD_SECRETKEY": "你的腾讯云SecretKey",
147+
"CLOUDBASE_ENV_ID": "你的云开发环境ID"
148+
}
149+
}
150+
}
151+
}
152+
```
93153

154+
使用模板中的 `.trae/rules/` 配置。
94155

156+
</details>
95157

158+
### 3. 开始开发
96159

97-
**案例3:智能监控修复**
98-
当用户反馈页面报错时:
160+
向 AI 描述你的需求:
99161

100-
1. AI通过MCP查看云函数错误日志,或者查看数据库集合写入情况
101-
2. 自动生成补丁代码并重新部署
102-
3. 问题解决无需人工介入
162+
```
163+
做一个双人在线对战五子棋网站,支持联机对战
164+
```
103165

166+
AI 会自动:
167+
- 📝 生成前后端代码
168+
- 🚀 部署到云开发
169+
- 🔗 返回在线访问链接
104170

105-
![](https://7463-tcb-advanced-a656fc-1257967285.tcb.qcloud.la/turbo-deploy/turbo-deploy-009.png)
171+
## ✨ 核心特性
106172

107-
## 🎯 为什么选择我们?
173+
| 特性 | 说明 | 优势 |
174+
|------|------|------|
175+
| **🤖 AI 原生** | 专为 AI 编程工具设计的规则库 | 生成代码符合云开发最佳实践 |
176+
| **🚀 一键部署** | MCP 自动化部署到腾讯云 | 无需手动配置服务器 |
177+
| **📱 全端支持** | Web + 小程序 + API 一体化 | 一套代码多端运行 |
178+
| **🔧 智能修复** | AI 自动查看日志并修复问题 | 降低运维成本 |
179+
| **⚡ 极速体验** | 国内 CDN 加速 | 比海外平台快 3-5 倍 |
108180

109-
**国内速度最快** 腾讯云国内节点,部署比海外平台快3-5倍
110-
**稳定可靠** 国内累计有 330万开发者使用云开发开发小程序和其他应用
111-
**全家桶支持** 唯一同时支持Web+小程序+API的一站式平台
112-
**AI深度优化** 专为AI开发者打造全栈应用代码生成规则
181+
## 📋 项目类型
113182

114-
## 🏁 使用指南
183+
### Web 应用
184+
- ✅ Vue/React/原生 JS
185+
- ✅ 现代化 UI 组件
186+
- ✅ 响应式设计
187+
- ✅ PWA 支持
115188

116-
### 1. 新建项目
189+
### 微信小程序
190+
- ✅ 云开发一体化
191+
- ✅ 实时数据同步
192+
- ✅ AI 能力集成
193+
- ✅ 丰富组件库
117194

118-
在本地创建一个空白项目,下载并集成云开发 CloudBase AI规则
195+
### 云函数 API
196+
- ✅ Serverless 架构
197+
- ✅ 自动扩缩容
198+
- ✅ 多语言支持
199+
- ✅ 安全认证
119200

120-
根据你使用的AI工具,将相应的规则目录复制到项目中:
201+
## 🎯 使用案例
121202

122-
| AI工具 | 规则目录 | 使用方法 |
123-
|--------|---------|---------|
124-
| **Cursor** | `.cursor/rules/` | 复制到项目根目录 |
125-
| **WindSurf** | `.windsurf/` | 复制到项目根目录 |
126-
| **CLINE** | `.clinerules/` | 复制到项目根目录 |
127-
| **CodeBuddy** | `.common_rules/` | 复制到项目根目录,对话时需要 add 选中具体的规则 |
128-
| **Github Copilot** | `.github/` | 复制到项目根目录 |
129-
| **Trae** | `.trae/rules/` | 复制到项目根目录 |
130-
| 通用规则 | `.common_rules/` | 适用于所有支持规则的AI工具,不支持的情况下需要 add 选中具体的规则 |
203+
### 案例1:双人在线对战五子棋
131204

132-
所有规则文件都包含相同的CloudBase开发指南,只是格式和位置根据不同AI工具而调整
205+
![](https://7463-tcb-advanced-a656fc-1257967285.tcb.qcloud.la/turbo-deploy/turbo-deploy-004.png)
133206

134-
### 2. 配置云开发 CloudBase MCP
207+
**开发过程:**
208+
1. 输入需求:"做个双人在线对战五子棋网站,支持联机对战"
209+
2. AI 生成:Web 应用 + 云数据库 + WebSocket 云函数
210+
3. 自动部署并获得访问链接
135211

136-
在 Cursor 等支持 MCP 的 AI IDE 中,打开 MCP 配置,加入云开发的 MCP
212+
👉 **体验地址:** [五子棋游戏](https://cloud1-5g39elugeec5ba0f-1300855855.tcloudbaseapp.com/gobang/#/)
137213

138-
注意:需要先[开通云开发环境](https://docs.cloudbase.net/quick-start/create-env)
214+
### 案例2:AI 宠物养成小程序
139215

140-
```js
141-
{
142-
"mcpServers": {
143-
"cloudbase-mcp": {
144-
"command": "npx",
145-
"args": ["@cloudbase/cloudbase-mcp"],
146-
"env": {
147-
"TENCENTCLOUD_SECRETID": "腾讯云 SecretId",
148-
"TENCENTCLOUD_SECRETKEY": "腾讯云 SecretKey",
149-
"CLOUDBASE_ENV_ID": "云开发环境 ID"
150-
}
151-
}
152-
}
153-
}
154-
```
216+
![](https://7463-tcb-advanced-a656fc-1257967285.tcb.qcloud.la/turbo-deploy/turbo-deploy-005.png)
155217

156-
### 3. 输入需求并生成
218+
**开发过程:**
219+
1. 输入:"开发一个宠物小精灵养成小程序,使用 AI 增强互动"
220+
2. AI 生成:小程序 + 云数据库 + AI 云函数
221+
3. 导入微信开发者工具即可发布
157222

158-
对AI说:"我要做一个______"
223+
👉 **小程序体验码:**
159224

160-
例如
161-
```
162-
做个双人在线对战五子棋网站,支持联机对战
225+
![](https://7463-tcb-advanced-a656fc-1257967285.tcb.qcloud.la/turbo-deploy/turbo-deploy-008.png)
226+
227+
### 案例3:智能问题诊断
228+
229+
![](https://7463-tcb-advanced-a656fc-1257967285.tcb.qcloud.la/turbo-deploy/turbo-deploy-009.png)
230+
231+
当应用出现问题时:
232+
1. AI 自动查看云函数日志
233+
2. 分析错误原因并生成修复代码
234+
3. 自动重新部署
235+
236+
## 🏗️ 架构图
237+
238+
```mermaid
239+
graph TD
240+
A[开发者] --> B[AI IDE]
241+
B -->|使用| C[CloudBase AI 规则]
242+
C --> D[生成代码]
243+
B -->|调用| E[CloudBase MCP]
244+
E --> F{检测部署}
245+
F -->|成功| G[云开发平台]
246+
F -->|失败| H[返回日志]
247+
H --> I[AI 修复]
248+
I --> E
249+
G --> J[线上应用]
250+
J --> K[Web/小程序/API]
163251
```
164252

165-
等着收你的线上应用链接或者小程序吧!
253+
## 🌟 为什么选择 CloudBase?
254+
255+
- **🇨🇳 国内领先**:330万+开发者的选择
256+
- **⚡ 极速部署**:国内节点,速度比海外快3-5倍
257+
- **🛡️ 稳定可靠**:腾讯云基础设施,99.95%可用性
258+
- **🔧 开发友好**:专为AI时代设计的全栈平台
259+
- **💰 成本优化**:按量付费,开发测试几乎免费
260+
261+
## 📚 进阶文档
166262

263+
- [云开发快速入门](https://docs.cloudbase.net/quick-start/)
264+
- [MCP 完整配置指南](https://github.com/TencentCloudBase/cloudbase-mcp)
265+
- [小程序开发最佳实践](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/)
266+
- [云函数开发指南](https://docs.cloudbase.net/cloud-function/)
267+
268+
## 🤝 贡献指南
269+
270+
欢迎提交 Issue 和 Pull Request!
271+
272+
1. Fork 本仓库
273+
2. 创建你的特性分支 (`git checkout -b feature/AmazingFeature`)
274+
3. 提交你的改动 (`git commit -m 'Add some AmazingFeature'`)
275+
4. 推送到分支 (`git push origin feature/AmazingFeature`)
276+
5. 打开一个 Pull Request
167277

168278
## 📄 开源协议
169279

170-
[MIT](LICENSE)
280+
[MIT](LICENSE) © TencentCloudBase
281+
282+
---
283+
284+
⭐ 如果这个项目对你有帮助,请给我们一个 Star!

0 commit comments

Comments
 (0)