From 932d882a10d1e9039f95c300e6707279651e53aa Mon Sep 17 00:00:00 2001
From: gitee-bot <no-reply@git.oschina.net>
Date: Sun, 12 Oct 2025 14:22:08 +0000
Subject: [PATCH] Add README.md

---
 README.en.md | 87 +++++++++++++++++++++++++++++++++++++++++++++++++++
 README.md    | 88 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 175 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..be84bb9
--- /dev/null
+++ b/README.en.md
@@ -0,0 +1,87 @@
+# Zero Boundary
+
+This is a low-code AI application development platform designed to help developers quickly build applications. Users can create, deploy, and manage applications through a simple interface and AI-assisted coding features.
+
+## Technology Stack
+
+- Spring Boot
+- MyBatis Plus
+- Redis
+- LangChain4j
+- OpenAI API
+- Vue 3
+- Vite
+
+## Key Features
+
+- **AI Code Generation**: Generate frontend code such as HTML, CSS, and JavaScript using AI models.
+- **Project Building**: Support one-click Vue project building.
+- **Chat History Records**: Save user interaction history for future reference.
+- **User Authentication and Permission Control**: Implement user registration, login, and role-based permission management.
+- **Rate Limiting Mechanism**: Prevent excessive API requests to protect system stability.
+- **File Operation Tools**: Provide functionalities such as file reading, writing, modification, and deletion.
+- **Screenshot Service**: Generate webpage screenshots and upload them to cloud storage.
+
+## Architecture Design
+
+The system is divided into two major parts: the backend service and the frontend interface.
+
+### Backend Modules
+
+- **Core Business Logic**: Handle core functionalities such as application creation, code generation, and project deployment.
+- **Data Access Layer**: Use MyBatis Plus for database operations.
+- **Cache Management**: Improve data access speed using Redis caching.
+- **Message Queue**: Asynchronously process tasks such as project building and screenshot generation.
+- **Security Control**: Includes authentication interceptors and rate-limiting aspects to ensure system security.
+
+### Frontend Modules
+
+- **Vue 3 + Vite**: A modern frontend framework ensuring high performance and a great development experience.
+- **Component-Based Development**: Modular component design makes maintenance and expansion easier.
+- **State Management**: Uses Pinia for state management.
+
+## Installation Guide
+
+### Backend Dependencies
+
+- JDK 17+
+- Maven
+- MySQL 8+
+- Redis 6+
+- Node.js (for frontend)
+
+### Frontend Dependencies
+
+- npm or yarn
+
+### Installation Steps
+
+1. Clone the repository to your local machine.
+2. Set up the database environment and import the SQL script from `db_sql/db.sql`.
+3. Modify the database connection information in `application.yml`.
+4. Build the backend project using Maven.
+5. Navigate to the `zero-code-frontend` directory and run `npm install` to install frontend dependencies.
+6. Start the backend service.
+7. In another terminal, run `npm run dev` to start the frontend development server.
+
+## Usage Instructions
+
+- Access the frontend page to start creating your first application.
+- Input a description of your requirements, and the system will automatically generate the corresponding code.
+- You can view the generated code, edit it directly on the platform, or download it.
+- Applications can be deployed to specified paths and accessed via a unique identifier.
+
+## Contribution Guide
+
+Contributions are welcome! Please follow these steps:
+
+1. Fork the repository.
+2. Create a new branch.
+3. Commit your changes.
+4. Submit a Pull Request.
+
+Before submitting, ensure all tests pass and your code adheres to the project's coding standards.
+
+## License
+
+This project is licensed under the MIT License. For details, please refer to the [LICENSE](LICENSE) file.
\ No newline at end of file
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..bd94afe
--- /dev/null
+++ b/README.md
@@ -0,0 +1,88 @@
+# Zero Boundary
+
+这是一个低代码 AI 应用开发平台，旨在帮助开发者快速构建应用程序。用户可以通过简单的界面和AI辅助编码功能来创建、部署和管理应用。
+
+## 技术栈
+
+- Spring Boot
+- MyBatis Plus
+- Redis
+- LangChain4j
+- OpenAI API
+- Vue 3
+- Vite
+
+## 功能特性
+
+- **AI代码生成**：利用AI模型生成HTML、CSS、JavaScript等前端代码。
+- **项目构建**：支持一键构建Vue项目。
+- **聊天历史记录**：保存用户的交互历史以便后续参考。
+- **用户认证与权限控制**：实现用户注册、登录及角色权限管理。
+- **限流机制**：防止API请求过于频繁，保护系统稳定运行。
+.
+- **文件操作工具**：提供文件读写、修改、删除等功能。
+- **截图服务**：生成网页截图并上传至云存储。
+
+## 架构设计
+
+系统分为后端服务和前端界面两大部分：
+
+### 后端模块
+
+- **核心业务逻辑**：处理应用创建、代码生成、项目部署等核心功能。
+- **数据访问层**：使用MyBatis Plus进行数据库操作。
+- **缓存管理**：通过Redis缓存提高数据访问速度。
+- **消息队列**：异步处理任务如项目构建和截图生成。
+- **安全控制**：包括认证拦截器和限流切面确保系统安全性。
+
+### 前端模块
+
+- **Vue 3 + Vite**：现代前端框架保证高性能和良好的开发体验。
+- **组件化开发**：模块化的组件设计便于维护和扩展。
+- **状态管理**：采用Pinia进行状态管理。
+
+## 安装指南
+
+### 后端依赖
+
+- JDK 17+
+- Maven
+- MySQL 8+
+- Redis 6+
+- Node.js (for frontend)
+
+### 前端依赖
+
+- npm 或 yarn
+
+### 安装步骤
+
+1. 克隆仓库到本地。
+2. 配置数据库环境，并导入`db_sql/db.sql`中的SQL脚本。
+3. 修改`application.yml`中的数据库连接信息。
+4. 使用Maven构建后端项目。
+5. 进入`zero-code-frontend`目录，运行`npm install`安装前端依赖。
+6. 启动后端服务。
+7. 在另一个终端中运行`npm run dev`启动前端开发服务器。
+
+## 使用说明
+
+- 访问前端页面开始创建你的第一个应用。
+- 输入需求描述，系统将自动生成相应的代码。
+- 可以查看生成的代码并在平台上直接编辑或下载。
+- 支持将应用部署到指定路径，并可通过唯一标识访问。
+
+## 贡献指南
+
+欢迎贡献代码！请遵循以下步骤：
+
+1. Fork仓库。
+2. 创建新分支。
+3. 提交更改。
+4. 发起Pull Request。
+
+在提交之前，请确保所有测试通过，并且代码风格符合项目规范。
+
+## 许可证
+
+本项目采用MIT许可证。详情请见[LICENSE](LICENSE)文件。
\ No newline at end of file
-- 
Gitee