# quick_curd

**Repository Path**: brisklan/quick_curd

## Basic Information

- **Project Name**: quick_curd
- **Description**: 基于element UI、thinkphp8的一键curd，不用编译哦！尽情享受吧！！！
- **Primary Language**: Unknown
- **License**: GPL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-07-05
- **Last Updated**: 2025-12-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Quick CURD 系统

这是一个一键CURD系统，支持低代码开发，前端使用 Element UI 和 Bootstrap，可快速开发后台功能，无需编译即可使用。

![后台管理](./screenshot/quick_curd1.png)
![CURD](./screenshot/quick_curd2.png)

## 特性

1. **一键CURD**：结合 Bootstrap 和 Element UI，快速生成增删改查功能，响应式设计，可扩展、可定制。
2. **无需编译**：开箱即用，无需任何编译步骤。
3. **支持多种开发模式**：支持 PHP + HTML 混搭（MVC）和 Vue 前后端分离（接口模式）。
4. **快速生成功能**：只需一张数据表即可生成完整的增删改查功能。

## 安装说明

### 1. 项目依赖包

请确保安装以下依赖：

- PHP 8.2 或更高版本
- MySQL 5.6 或更高版本
- Composer（用于 PHP 依赖管理）
- 支持在线上传安装包的方式更新

### 2. 运行方式

#### 使用 Docker 运行

1. 确保已安装 Docker 和 Docker Compose。
2. 在项目根目录下运行以下命令(推荐)：

```bash
docker-compose up -d
```
 强制重建
```bash
docker compose up --build --force-recreate -d
```
或者用 
```bash 
docker build -t quick-curd -f docker/Dockerfile  .
````
 构建镜像。然后运行：
```bash
docker run -p 8899:80 -d quick-curd
```

这将启动 PHP、Nginx 和 MySQL 容器，并自动部署项目。

## 使用说明

### 快速开始

1. **配置数据库**：在 `src/.env` 中配置数据库连接信息。
2. **生成 CURD 功能**：访问后台管理界面，输入数据表结构，系统将自动生成对应的增删改查功能。
3. **自定义界面**：通过模板文件（如 `src/app/controller/admin/view/` 下的 HTML 文件）自定义前端界面。
4. **部署项目**：使用 Docker 或手动部署到服务器。

## 目录结构

- **src/**：项目核心代码目录
  - **app/**：控制器、模型、服务等逻辑代码
  - **config/**：配置文件（数据库、缓存、路由等）
  - **public/**：静态资源（CSS、JS、图片等）
  - **extend/**：扩展类库（如日志、异常处理等）
  - **install/**：安装脚本和 SQL 文件

## 功能模块

- **管理员模块**：支持管理员登录、权限管理、角色分配等。
- **日志模块**：记录访问日志、登录日志、操作日志等。
- **备份与恢复**：支持数据库备份与恢复功能。
- **文件上传**：支持图片、文件上传及管理。
- **设置管理**：支持系统参数、配置的动态调整。
- **统计模块**：提供系统运行数据的统计与展示。

## 开发者文档

### 控制器

- **BaseAdmin**：所有后台控制器的基类，提供权限验证、初始化等功能。
- **Curd**：CURD 功能的核心控制器，提供基础的增删改查接口。
- **Login**：登录控制器，处理管理员登录与登出逻辑。

### 模型

- **BaseModel**：所有模型的基类，封装了通用的数据库操作方法。
- **Admin**：管理员模型，处理管理员相关数据。
- **Role**：角色模型，用于权限管理。
- **UploadFilesLog**：上传文件日志模型，记录文件上传信息。

### 前端资源

- **Element UI**：用于构建后台管理界面。
- **Bootstrap 4.6.2**：提供响应式布局和基础样式。
- **Editor.md**：Markdown 编辑器，用于内容编辑。
- **CodeMirror**：代码编辑器插件，支持语法高亮和代码折叠。


### 更新
1. 自己拉取代码对比更新
2. 用在线更新功能【自己写的类似`git diff`功能】：上传代码对比更新(更新包目录层级按系统层级，比如下面的，仅支持增改文件，删除暂不支持)
![在线更新对比](./screenshot/update.png)
```bash
├─app
│  │  ExceptionHandle.php
│  │  middleware.php
│  │  provider.php
│  │  service.php
│  │
│  └─admin
│      ├─config
│      │      route.php
│      │      session.php
│      │      view.php
│      │
│      └─controller
│              AccessLog.php
│
└─update
        1.0.sql.php
        version.json
```
`tree /f` 查看你的目录层级

## 贡献指南

欢迎贡献代码和改进文档。请遵循以下步骤：

1. Fork 项目。
2. 创建新分支。
3. 提交代码。
4. 创建 Pull Request。

## 待优化
- 权限控制颗粒度配置
- 角色权限配置

## 许可证

本项目遵循 GPLv2 许可证。详情请查看 [LICENSE](LICENSE) 文件。