Skip to content

Commit 5b062c1

Browse files
committed
docs: Updated README with new features's explanation
1 parent 6f7cf7b commit 5b062c1

18 files changed

+134
-65
lines changed

README.md

Lines changed: 60 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
# 𝐜𝐡𝐚𝐭𝐒𝐐𝐋
1+
<h1 align="center">
2+
<a href="https://chat-sql-hazel.vercel.app/" target="_blank">
3+
<img src="./chat-sql/public/assets/navLogo.png" width="300" alt="ChatSQL">
4+
</a>
5+
</h1>
26

37
[English](./README_EN.md) | 简体中文
48

@@ -12,53 +16,77 @@
1216
<p align="center" style="font-size: 1.2em; margin: 20px 0;">
1317
<a href="https://chat-sql-hazel.vercel.app/" target="_blank" style="font-size: 1.2em; font-weight: bold;">Website</a>
1418
</p>
19+
<img src="./chat-sql/public/assets/demo.png">
1520

21+
C𝐡𝐚𝐭𝐒𝐐𝐋 是一个交互式的数据库系统学习平台,通过智能体设计与工作流编排,协同前端xyflow等组件库的二次开发与深度适配,帮助用户从入门到精通 SQL 查询、ER图结构设计与B+树操作理解.
1622

17-
ChatSQL 是一个交互式 SQL 学习平台,通过人工智能技术生成个性化的 SQL 练习题,帮助用户从入门到精通 SQL 查询语言。平台结合了直观的数据库可视化工具、智能代码编辑器和即时反馈系统,为用户提供沉浸式学习体验。无论您是 SQL 初学者还是希望提升查询技能的开发者,ChatSQL 都能根据您的水平定制适合的学习内容,让 SQL 学习变得更加高效和有趣。
23+
## 项目核心模块介绍
1824

19-
## ✨ 特性
25+
C𝐡𝐚𝐭𝐒𝐐𝐋 由以下核心模块组成:
2026

21-
- 🤖 AI 生成练习:提供两种方式的习题来源
22-
- 通过预设的教程, 循序渐进地练习`select`, `join`, 聚合操作与嵌套子查询等知识点.
27+
- **SQL编程实践模块**:供用户练习SQL查询,提供dify生成与预制课程两方面来源的练习
28+
- **ER图设计模块**:提供ER图建模工具、ER图建模问题生成与智能体测评反馈
29+
- **B+树操作模块**:实现B+树操作可视化
30+
- **ChatBot模块**:基于专业知识库的通用问答,辅助数据库系统课程的学习
31+
32+
### SQL编程实践模块
33+
34+
#### 功能设计
35+
36+
<img src="./chat-sql/public/assets/design-SQL.png">
37+
38+
- 🤖 **智能体生成练习**:提供两种方式的习题来源
39+
40+
- 通过预设的教程, 循序渐进地练习 `select`, `join`, 聚合操作与嵌套子查询等知识点.
2341
- 与dify工作流交互, 输入难度,标签与描述自动生成 SQL 练习题.
42+
- 📊 **数据库结构可视化**:直观展示表关系和字段信息, 外检约束等信息一目了然;
43+
- ⌨️ **Monaco编辑器与schema的补全整合**
2444

25-
- 📊 数据库结构可视化:直观展示表关系和字段信息, 外检约束等信息一目了然;
26-
- ⌨️ Monaco编辑器与schema的补全整合:
2745
- 支持sql语法高亮和悬浮的语法提示
28-
- 针对当前schema信息提供`tab`的自动补全
46+
- 针对当前schema信息提供 `tab`的自动补全
47+
- 📝 **即时结果验证**:实时验证查询结果
2948

30-
- 📝 即时结果验证:实时验证查询结果
31-
- 由构建于前端的sql引擎0延迟地处理sql查询结果.
3249
- 支持将查询结果与期望结果进行比较, 评价查询结果是否正确.
3350

51+
#### 运行效果
52+
53+
<img src="./chat-sql/public/assets/ret-SQL.png">
3454

55+
### ER图设计模块
3556

57+
#### 功能设计
3658

37-
## 🖥 界面预览
59+
<img src="./chat-sql/public/assets/design-ER.png">
3860

39-
### 初始化界面
61+
#### 运行效果
4062

41-
![](https://my-blog-img-1358266118.cos.ap-guangzhou.myqcloud.com/undefined20250508164908220.png?imageSlim)
63+
<img src="./chat-sql/public/assets/ret-ER.png">
4264

43-
- 点击侧边栏中的“初始化教程”, 可以同预设的数据库表结构进行交互;
44-
- 点击侧边栏中的“帮助”, 可以查看基本的操作演示.
65+
### B+树操作模块
4566

46-
### 数据库结构可视化
67+
#### 功能设计
4768

48-
![](https://my-blog-img-1358266118.cos.ap-guangzhou.myqcloud.com/undefined20250508165221364.png?imageSlim)
69+
<img src="./chat-sql/public/assets/design-B+.png">
4970

50-
- 默认显示数据库结构的可视化视图;
51-
- 可在左下角切换元组视图.
71+
#### 运行效果
5272

53-
### SQL 编辑器演示
73+
<img src="./chat-sql/public/assets/ret-B+.png">
5474

55-
<img src="./chat-sql/public/assets/edit.gif" alt="编辑器演示" width="80%" />
75+
### ChatBot模块
5676

57-
对应快捷键:
77+
#### 功能设计
5878

59-
- `command+enter` : 执行查询
60-
- `command+j`: 检测查询结果是否匹配;
61-
- `command+k`: 搜索历史记录.
79+
<img src="./chat-sql/public/assets/design-chat.png">
80+
81+
#### 运行效果
82+
83+
<img src="./chat-sql/public/assets/ret-chat.png">
84+
85+
## 未来计划
86+
87+
### 苏格拉底式对话智能体
88+
89+
<img src="./chat-sql/public/assets/future-chat.png">
6290

6391
## 🛠 技术栈
6492

@@ -71,23 +99,22 @@ ChatSQL 是一个交互式 SQL 学习平台,通过人工智能技术生成个
7199
<img src="https://img.shields.io/badge/Monaco%20Editor-DD1100?style=for-the-badge&logo=visualstudiocode&logoColor=white" alt="Monaco Editor" />
72100
<img src="https://img.shields.io/badge/XY%20Flow-22C55E?style=for-the-badge&logo=diagram&logoColor=white" alt="XY Flow" />
73101
</p>
102+
<img src="./chat-sql/public/assets/framework.png">
74103

75-
- **框架**: [Next.js](https://nextjs.org/) 15.3.0
104+
- **框架**: [Next.js](https://nextjs.org/)
76105
- **UI 组件**:
77-
- [Ant Design](https://ant.design/) 5.24.6
78-
- [Material-UI](https://mui.com/) 7.0.2
106+
- [Ant Design](https://ant.design/)
107+
- [Material-UI](https://mui.com/)
79108
- **编辑器**: [Monaco Editor](https://microsoft.github.io/monaco-editor/)
80109
- **流程图**:
81110
- [XY Flow](https://reactflow.dev/) (@xyflow/react)
82-
- 用于数据库表关系可视化
83-
- 支持自定义节点和边的样式
84-
- 提供图表交互操作
85-
- 基于 D3.js 的缩放和拖拽功能
86-
- **AI 集成**: [Dify.ai](https://dify.ai/)
111+
- **AI 集成**: [Dify.ai](https://dify.ai/) && [阿里云百炼](https://bailian.console.aliyun.com/?utm_content=se_1021228063&gclid=CjwKCAjw49vEBhAVEiwADnMbbN8YRdE4pNrz9txN0_KcUqiOuUc9aPSgyMDqlti1KVOPf5-o-yL1jBoC3usQAvD_BwE#/home)
87112
- **类型检查**: [TypeScript](https://www.typescriptlang.org/)
88113

89114
## 🚀 快速开始
90115

116+
> **TODO**:提供百炼平台端的智能体/工作流设计文件 or 迁移到dify
117+
91118
### 前置要求
92119

93120
- Node.js 18.0 或更高版本

README_EN.md

Lines changed: 74 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,12 @@
1-
# 𝐜𝐡𝐚𝐭𝐒𝐐𝐋
1+
2+
3+
<h1 align="center">
4+
<a href="https://chat-sql-hazel.vercel.app/" target="_blank">
5+
<img src="./chat-sql/public/assets/navLogo.png" width="300" alt="ChatSQL">
6+
</a>
7+
</h1>
8+
9+
210

311
English | [简体中文](./README.md)
412

@@ -12,42 +20,77 @@ English | [简体中文](./README.md)
1220
<p align="center" style="font-size: 1.2em; margin: 20px 0;">
1321
<a href="https://chat-sql-hazel.vercel.app/" target="_blank" style="font-size: 1.2em; font-weight: bold;">Website</a>
1422
</p>
15-
ChatSQL is an interactive SQL learning platform that leverages artificial intelligence to generate personalized SQL exercises, helping users master SQL query language from beginner to advanced levels. The platform combines intuitive database visualization tools, a smart code editor, and real-time feedback system to provide an immersive learning experience. Whether you're a SQL beginner or a developer looking to enhance your query skills, ChatSQL tailors learning content to your proficiency level, making SQL learning more efficient and engaging.
23+
<img src="./chat-sql/public/assets/demo.png">
24+
25+
C𝐡𝐚𝐭𝐒𝐐𝐋 is an interactive database system learning platform that helps users master SQL queries, ER diagram design, and B+ tree operations from beginner to advanced levels through intelligent agent design and workflow orchestration, combined with secondary development and deep adaptation of frontend components like xyflow.
26+
27+
## Core Module Introduction
28+
29+
C𝐡𝐚𝐭𝐒𝐐𝐋 consists of the following core modules:
1630

17-
## ✨ Features
31+
- **SQL Programming Practice Module**: Provides users with SQL query practice, offering exercises from both Dify-generated and preset course sources
32+
- **ER Diagram Design Module**: Provides ER diagram modeling tools, ER diagram modeling problem generation, and intelligent agent evaluation feedback
33+
- **B+ Tree Operation Module**: Implements B+ tree operation visualization
34+
- **ChatBot Module**: General Q&A based on professional knowledge base, assisting in database system course learning
35+
36+
### SQL Programming Practice Module
37+
38+
#### Feature Design
39+
40+
<img src="./chat-sql/public/assets/design-SQL.png">
41+
42+
- 🤖 **AI-Generated Exercises**: Provides two sources of practice problems
1843

19-
- 🤖 AI-Generated Exercises: Two sources of practice problems
2044
- Through preset tutorials, progressively practice `select`, `join`, aggregation operations, and nested subqueries.
2145
- Interact with Dify workflow to automatically generate SQL exercises by inputting difficulty, tags, and descriptions.
46+
- 📊 **Database Structure Visualization**: Intuitively displays table relationships and field information, with foreign key constraints clearly visible
47+
- ⌨️ **Monaco Editor with Schema Integration**:
2248

23-
- 📊 Database Structure Visualization: Intuitively displays table relationships and field information, with foreign key constraints clearly visible.
24-
- ⌨️ Monaco Editor with Schema Completion Integration:
2549
- Supports SQL syntax highlighting and hover syntax tips
2650
- Provides `tab` auto-completion based on current schema information
51+
- 📝 **Instant Result Validation**: Real-time verification of query results
52+
53+
- Supports comparing query results with expected results to evaluate query correctness
54+
55+
#### Runtime Results
56+
57+
<img src="./chat-sql/public/assets/ret-SQL.png">
2758

28-
- 📝 Instant Result Validation: Real-time verification of query results
29-
- SQL engine built into the frontend processes query results with zero delay
30-
- Supports comparing query results with expected results to evaluate correctness
59+
### ER Diagram Design Module
3160

32-
## 🖥 Interface Preview
61+
#### Feature Design
3362

34-
### Initialization Interface
35-
![](https://my-blog-img-1358266118.cos.ap-guangzhou.myqcloud.com/undefined20250508164908220.png?imageSlim)
36-
- Click "Initialization Tutorial" in the sidebar to interact with the preset database structure
37-
- Click "Help" in the sidebar to view basic operation demonstrations
63+
<img src="./chat-sql/public/assets/design-ER.png">
3864

39-
### Database Structure Visualization
40-
![](https://my-blog-img-1358266118.cos.ap-guangzhou.myqcloud.com/undefined20250508165221364.png?imageSlim)
41-
- Database structure visualization view is displayed by default
42-
- You can switch to tuple view in the bottom left corner
65+
#### Runtime Results
4366

44-
### SQL Editor Demo
45-
<img src="./chat-sql/public/assets/edit.gif" alt="Editor Demo" width="80%" />
67+
<img src="./chat-sql/public/assets/ret-ER.png">
4668

47-
Corresponding shortcuts:
48-
- `command+enter` : Execute query
49-
- `command+j`: Check if query results match
50-
- `command+k`: Search history records
69+
### B+ Tree Operation Module
70+
71+
#### Feature Design
72+
73+
<img src="./chat-sql/public/assets/design-B+.png">
74+
75+
#### Runtime Results
76+
77+
<img src="./chat-sql/public/assets/ret-B+.png">
78+
79+
### ChatBot Module
80+
81+
#### Feature Design
82+
83+
<img src="./chat-sql/public/assets/design-chat.png">
84+
85+
#### Runtime Results
86+
87+
<img src="./chat-sql/public/assets/ret-chat.png">
88+
89+
## Future Plans
90+
91+
### Socratic Dialogue Agent
92+
93+
<img src="./chat-sql/public/assets/future-chat.png">
5194

5295
## 🛠 Tech Stack
5396

@@ -60,23 +103,22 @@ Corresponding shortcuts:
60103
<img src="https://img.shields.io/badge/Monaco%20Editor-DD1100?style=for-the-badge&logo=visualstudiocode&logoColor=white" alt="Monaco Editor" />
61104
<img src="https://img.shields.io/badge/XY%20Flow-22C55E?style=for-the-badge&logo=diagram&logoColor=white" alt="XY Flow" />
62105
</p>
106+
<img src="./chat-sql/public/assets/framework.png">
63107

64-
- **Framework**: [Next.js](https://nextjs.org/) 15.3.0
108+
- **Framework**: [Next.js](https://nextjs.org/)
65109
- **UI Components**:
66-
- [Ant Design](https://ant.design/) 5.24.6
67-
- [Material-UI](https://mui.com/) 7.0.2
110+
- [Ant Design](https://ant.design/)
111+
- [Material-UI](https://mui.com/)
68112
- **Editor**: [Monaco Editor](https://microsoft.github.io/monaco-editor/)
69113
- **Flow Diagram**:
70114
- [XY Flow](https://reactflow.dev/) (@xyflow/react)
71-
- For database table relationship visualization
72-
- Supports custom node and edge styles
73-
- Provides interactive chart operations
74-
- D3.js-based zooming and dragging functionality
75-
- **AI Integration**: [Dify.ai](https://dify.ai/)
115+
- **AI Integration**: [Dify.ai](https://dify.ai/) && [Alibaba Cloud Bailian](https://bailian.console.aliyun.com/?utm_content=se_1021228063&gclid=CjwKCAjw49vEBhAVEiwADnMbbN8YRdE4pNrz9txN0_KcUqiOuUc9aPSgyMDqlti1KVOPf5-o-yL1jBoC3usQAvD_BwE#/home)
76116
- **Type Checking**: [TypeScript](https://www.typescriptlang.org/)
77117

78118
## 🚀 Quick Start
79119

120+
> **TODO**: Provide intelligent agent/workflow design files for Bailian platform or migrate to Dify
121+
80122
### Prerequisites
81123

82124
- Node.js 18.0 or higher
227 KB
Loading

chat-sql/public/assets/demo.png

608 KB
Loading
735 KB
Loading
749 KB
Loading
562 KB
Loading
327 KB
Loading

chat-sql/public/assets/edit.gif

-7.28 MB
Binary file not shown.
541 KB
Loading

0 commit comments

Comments
 (0)