From d4e370585cecfd0f34b0f78cbb7d9724b10702ca Mon Sep 17 00:00:00 2001 From: gitee-bot Date: Sun, 12 Oct 2025 10:49:53 +0000 Subject: [PATCH] Add README.md --- README.en.md | 60 ++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 60 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 120 insertions(+) create mode 100644 README.en.md create mode 100644 README.md diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000..da3a02e --- /dev/null +++ b/README.en.md @@ -0,0 +1,60 @@ +# Admin Management System + +This is an admin management system built with Next.js and Shadcn UI, offering core features such as Agent management, workflow building, and code generation. + +## Key Features + +- **Visual Agent Builder**: Supports drag-and-drop component editing with real-time configuration preview. +- **Hierarchical Code Generation**: Automatically generates well-structured LangGraph code. +- **Workflow Management**: Provides complete workflow design and debugging capabilities. +- **Responsive Layout**: Friendly interactions across different screen sizes. +- **Theme Support**: Includes dark/light mode switching. + +## Technology Stack + +The project uses a modern frontend architecture: +- Next.js App Router +- React Flow for visual flowcharts +- Shadcn UI component library +- Tailwind CSS styling system +- TypeScript for type safety +- Radix UI for base components + +## Core Modules + +### Agent Builder +Supports creating AI Agents via drag-and-drop components, including: +- **Component Library**: Basic components such as LLM, Memory, Tool +- **Canvas Editing**: Visual connection of components +- **Property Configuration**: Real-time modification of component parameters +- **Code Generation**: Export complete LangGraph code + +### Workflow Builder +Provides a visual workflow design interface, supporting: +- Node connections +- Process debugging +- State persistence + +### Code Viewer +Displays the generated LangGraph code, supporting: +- Hierarchical viewing +- Code copying +- File downloading + +## Usage Instructions + +1. **Create a New Agent**: Drag components from the library onto the canvas. +2. **Configure Parameters**: Click on a component to set its properties. +3. **Connect Nodes**: Drag connectors to establish component relationships. +4. **Save Progress**: Click the save button to persist data. +5. **Test and Run**: Click the test button to validate the workflow. + +## Contribution Guidelines +Code contributions are welcome. Please follow these guidelines: +1. Ensure tests pass before submitting. +2. Maintain consistent code style. +3. Submit meaningful commit messages. +4. Follow component naming conventions. + +## License +This project is licensed under the MIT open-source license. See the LICENSE file for details. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..9e26ac0 --- /dev/null +++ b/README.md @@ -0,0 +1,60 @@ +# 后台管理系统 + +这是一个基于Next.js和Shadcn UI构建的后台管理系统,提供了Agent管理、工作流构建、代码生成等核心功能。 + +## 功能特性 + +- **可视化Agent构建**:支持拖拽式组件编辑,实时预览配置 +- **分层代码生成**:自动生成结构清晰的LangGraph代码 +- **工作流管理**:提供完整的工作流设计和调试能力 +- **响应式布局**:适配不同屏幕尺寸的友好交互 +- **主题支持**:包含深色/浅色模式切换 + +## 技术架构 + +项目采用现代前端架构设计: +- Next.js App Router +- React Flow可视化流程图 +- Shadcn UI组件库 +- Tailwind CSS样式系统 +- TypeScript类型安全 +- Radix UI基础组件 + +## 核心模块 + +### Agent构建器 +支持通过拖拽组件创建AI Agent,包含: +- 组件库:LLM、Memory、Tool等基础组件 +- 画布编辑:可视化连接组件 +- 属性配置:实时修改组件参数 +- 代码生成:导出完整LangGraph代码 + +### 工作流构建 +提供可视化工作流设计界面,支持: +- 节点连接 +- 流程调试 +- 状态保存 + +### 代码查看器 +展示生成的LangGraph代码,支持: +- 分层查看 +- 代码复制 +- 文件下载 + +## 使用说明 + +1. 创建新Agent:从组件库拖拽组件到画布 +2. 配置参数:点击组件设置属性 +3. 连接节点:拖拽连接线建立组件关系 +4. 保存进度:点击保存按钮持久化数据 +5. 测试运行:点击测试按钮验证流程 + +## 贡献指南 +欢迎贡献代码,请遵循以下规范: +1. 提交前确保测试通过 +2. 保持代码风格一致性 +3. 提交有意义的commit信息 +4. 遵循组件命名规范 + +## 许可协议 +本项目采用MIT开源许可协议,详见LICENSE文件。 \ No newline at end of file -- Gitee