Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
refactor(gen): 重构代码生成模块,实现权限认证和分页支持
- 重构GenTableDao和GenTableColumnDao,继承CRUDBase,添加权限鉴权支持
- 优化分页逻辑,支持非分页时返回完整结果集
- 调整查询条件,支持大小写不敏感模糊查询和时间范围过滤
- 统一接口响应格式,返回SuccessResponse或ErrorResponse
- 替换旧的依赖和注解,改用新的认证和日志中间件
- 文档README.en.md和README.md内容格式及示例完善与优化
- alembic/env.py中数据库URL配置优化,增加异常检测保障环境配置正确
- 代码生成控制器genController新增代码批量生成下载流和本地生成文件覆盖检测
- 删除或更新废弃代码,清理无用导入,提升项目整体代码质量和可维护性
  • Loading branch information
zhangtao
zhangtao committed Sep 19, 2025
commit 60fe97afc3a0d522e9a7597344c07ebab6d25a40
55 changes: 15 additions & 40 deletions README.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,21 +23,19 @@
<img src="https://img.shields.io/badge/-CSS3-1572B6?style=flat-square&logo=css3"/>
<img src="https://img.shields.io/badge/-JavaScript-563D7C?style=flat-square&logo=bootstrap"/>
</p>
</div>

---

English | [Chinese](./README.md)

---
</div>

## 📘 Project Introduction (Author: @1014TaoTao)
## 📘 Project Introduction

**Fastapi-Vue3-Admin** is a **completely open-source, highly modular, and technologically advanced modern rapid development platform**. Its aim is to help developers efficiently build high-quality enterprise-level mid - and back - end systems. This project adopts a **front - end and back - end separation architecture**, integrating the Python back - end framework `FastAPI` and the mainstream front - end framework `Vue3` to achieve unified development across multiple terminals, providing a one - stop out - of - the - box development experience.

> **Original Design Concept**: With modularity and loose coupling at its core, it pursues rich functional modules, simple and easy - to - use interfaces, detailed development documentation, and convenient maintenance methods. By unifying frameworks and components, it reduces the cost of technology selection, follows development specifications and design patterns, builds a powerful code hierarchical model, and comes with comprehensive local Chinese support. It is specifically tailored for team and enterprise development scenarios.

## 📦Engineering Structures

```sh
fastapi_vue3_admin
├─ backend # Backend project
Expand All @@ -52,8 +50,6 @@ fastapi_vue3_admin
└─ README.md # Chinese documentation
```

---

## ✨ Core Highlights

| Feature | Description |
Expand All @@ -68,8 +64,6 @@ fastapi_vue3_admin
| 📄 Developer-friendly | Provides comprehensive Chinese documentation, a Chinese interface, and a visual toolchain to reduce the learning curve. |
| 🧩 Quick Access | Based on mainstream front-end technology stacks such as Vue3, Vite5, Pinia, and ElementPlus, it's ready to use out of the box. |

---

## 🛠️ Technology Stack Overview

| Type | Technology Selection | Description |
Expand All @@ -85,8 +79,6 @@ fastapi_vue3_admin
| Documentation | Swagger / Redoc | Automatically generate API documentation. |
| Deployment | Docker / Nginx / Docker Compose | Rapidly deploy projects. |

---

## 📌 Built-in Modules

| Module Name | Sub-module Name | Description |
Expand All @@ -96,17 +88,12 @@ fastapi_vue3_admin
| Monitoring Management | Online users, server monitoring, cache monitoring | System monitoring and management functions |
| Public Management | Interface management, document management | Project interface documentation |

---

## 🍪 Demo Environment

- Official website: <https://service.fastapiadmin.com>
- Web address: <https://service.fastapiadmin.com/web>
- App address: <https://service.fastapiadmin.com/app>
- Admin account: `admin` Password: `123456`
- Demo account: `demo` Password: `123456`

---
- Account: `admin` Password: `123456`

## 👷 Installation and Usage

Expand All @@ -125,8 +112,6 @@ fastapi_vue3_admin
| Database | MySQL | 8.0 (It is recommended to use the latest version.) |
| Middleware | Redis | 7.0 (It is recommended to use the latest version.) |

---

### Get Code

```sh
Expand All @@ -136,8 +121,6 @@ git clone https://gitee.com/tao__tao/fastapi_vue3_admin.git
git clone https://github.com/1014TaoTao/fastapi_vue3_admin.git
```

---

### Local Backend Start

```sh
Expand All @@ -155,8 +138,6 @@ python3 main.py revision "Initial migration" --env=dev (default is dev if not sp
python3 main.py upgrade --env=dev (default is dev if not specified)
```

---

### Local Frontend Start

```sh
Expand All @@ -170,8 +151,6 @@ pnpm run dev
pnpm run build
```

---

### Local App H5 Start

```sh
Expand All @@ -185,8 +164,6 @@ pnpm run dev:h5
pnpm run build:h5
```

---

### Local Project Website Start

```sh
Expand All @@ -200,8 +177,6 @@ pnpm run docs:dev
pnpm run docs:build
```

---

### Local Access Address

- Project official website address: <http://localhost:5180>
Expand All @@ -210,8 +185,6 @@ pnpm run docs:build
- Admin account: `admin` Password: `123456`
- Demo account: `demo` Password: `123456`

---

### Docker Build

```sh
Expand Down Expand Up @@ -244,8 +217,6 @@ fastapi_vue3_admin/devops/devops/nginx/nginx.conf

```

---

## 🔧 Models

| Module | Screenshot |
Expand All @@ -270,13 +241,12 @@ fastapi_vue3_admin/devops/devops/nginx/nginx.conf
| Document | ![Document](./fastdocs/src/public/help.png) |
| Lock | ![Lock](./fastdocs/src/public/lock.png) |

### 移动端
### Mobile

| Module <div style="width:60px"/> | Details | Module <div style="width:60px"/> | Details | Module <div style="width:60px"/> | Details |
|----------|------|----------|------|----------|------|
| Login | ![Mobile Login](./fastdocs/src/public/app_login.png) | Home | ![Mobile Home](./fastdocs/src/public/app_home.png) | Profile | ![Mobile Profile](./fastdocs/src/public/app_mine.png) |
| Personal | ![Mobile Personal Info](./fastdocs/src/public/app_profile.png) | Settings | ![Mobile Settings](./fastdocs/src/public/app_setting.png) | Workbench | ![Mobile Workbench](./fastdocs/src/public/app_work.png) |
---

## 🛠️ Secondary Development Tutorial

Expand All @@ -303,8 +273,15 @@ fastapi_vue3_admin/devops/devops/nginx/nginx.conf
1. **Configure the mobile access address for backend interfaces**: Write the code in `fastapp/src/api`.
2. **Write mobile pages**: Write the code in `fastapp/src/pages`.

## ℹ️ Help

For more details, please check the [Official Documentation](https://service.fastapiadmin.com)

## 👥 Contributors

---
<a href="https://github.com/1014TaoTao/fastapi_vue3_admin/graphs/contributors">
<img src="https://contrib.rocks/image?repo=1014TaoTao/fastapi_vue3_admin"/>
</a>

## 🙏 Thanks

Expand All @@ -321,16 +298,14 @@ Thanks to the contributions and support of the following projects, which have en
- [Vue3-element-admin Project](https://gitee.com/youlaiorg/vue3-element-admin)
- [Vue3-element-plus-admin Project](https://gitee.com/kailong110120130/vue-element-plus-admin)

---

## 🎨 Community

| WeChat QR Code | Group QR Code | WeChat Pay QR Code |
| --- | --- | --- |
| ![WeChat QR Code](./fastdocs/src/public/wechat.jpg) | ![Group QR Code](./fastdocs/src/public/group.jpg) | ![WeChat Pay QR Code](./fastdocs/src/public/wechatPay.jpg) |

---

## ❤️ Star

If you like this project, please give it a ⭐️ Star to show your support! Thank you very much!

[![Stargazers over time](https://starchart.cc/1014TaoTao/fastapi_vue3_admin.svg?variant=adaptive)](https://starchart.cc/1014TaoTao/fastapi_vue3_admin)
53 changes: 15 additions & 38 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,21 +23,19 @@
<img src="https://img.shields.io/badge/-CSS3-1572B6?style=flat-square&logo=css3"/>
<img src="https://img.shields.io/badge/-JavaScript-563D7C?style=flat-square&logo=bootstrap"/>
</p>
</div>

---

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

---
</div>

## 📘 项目介绍(作者:@1014TaoTao)
## 📘 项目介绍

**Fastapi-Vue3-Admin** 是一套 **完全开源、高度模块化、技术先进的现代化快速开发平台**,旨在帮助开发者高效搭建高质量的企业级中后台系统。该项目采用 **前后端分离架构**,融合 Python 后端框架 `FastAPI` 和前端主流框架 `Vue3` 实现多端统一开发,提供了一站式开箱即用的开发体验。

> **设计初心**: 以模块化、松耦合为核心,追求丰富的功能模块、简洁易用的接口、详尽的开发文档和便捷的维护方式。通过统一框架和组件,降低技术选型成本,遵循开发规范和设计模式,构建强大的代码分层模型,搭配完善的本地中文化支持,专为团队和企业开发场景量身定制。

## 📦工程结构概览

```sh
fastapi_vue3_admin
├─ backend # 后端工程
Expand All @@ -52,8 +50,6 @@ fastapi_vue3_admin
└─ README.md # 中文文档
```

---

## ✨ 核心亮点

| 特性 | 描述 |
Expand All @@ -68,8 +64,6 @@ fastapi_vue3_admin
| 📄 开发友好 | 提供完善的中文文档 + 中文化界面 + 可视化工具链,降低学习成本 |
| 🧩 快速接入 |基于 Vue3、Vite5、Pinia、ElementPlus 等主流前端技术栈,开箱即用。|

---

## 🛠️ 技术栈概览

| 类型 | 技术选型 | 描述 |
Expand All @@ -85,8 +79,6 @@ fastapi_vue3_admin
| 文档 | Swagger / Redoc | 自动生成 API 文档。 |
| 部署 | Docker / Nginx / Docker Compose | 快速部署项目。 |

---

## 📌 内置模块

| 模块名 | 子模块名 | 描述 |
Expand All @@ -96,17 +88,12 @@ fastapi_vue3_admin
| 监控管理 | 在线用户、服务器监控、缓存监控 |系统监控管理功能 |
| 公共管理 | 接口管理、文档管理|项目接口文档 |

---

## 🍪 演示环境

- 官网地址:<https://service.fastapiadmin.com>
- 演示地址:<https://service.fastapiadmin.com/web>
- 小程序地址:<https://service.fastapiadmin.com/app>
- 管理员账号:`admin` 密码:`123456`
- 演示账号:`demo` 密码:`123456`

---
- 登录账号:`admin` 密码:`123456`

## 👷 安装和使用

Expand All @@ -125,8 +112,6 @@ fastapi_vue3_admin
| 数据库 | MySQL | 8.0 (推荐使用最新版)|
| 中间件 | Redis | 7.0 (推荐使用最新版)|

---

### 获取代码

```sh
Expand All @@ -136,8 +121,6 @@ git clone https://gitee.com/tao__tao/fastapi_vue3_admin.git
git clone https://github.com/1014TaoTao/fastapi_vue3_admin.git
```

---

### 本地后端启动

```sh
Expand All @@ -155,8 +138,6 @@ python3 main.py revision "初始化迁移" --env=dev(不加默认为dev)
python3 main.py upgrade --env=dev(不加默认为dev)
```

---

### 本地前端启动

```sh
Expand All @@ -170,8 +151,6 @@ pnpm run dev
pnpm run build
```

---

### 本地小程序h5启动

```sh
Expand All @@ -185,8 +164,6 @@ pnpm run dev:h5
pnpm run build:h5
```

---

### 本地项目官网启动

```sh
Expand All @@ -200,8 +177,6 @@ pnpm run docs:dev
pnpm run docs:build
```

---

### 本地访问地址

- 项目官网地址: <http://localhost:5180>
Expand All @@ -210,8 +185,6 @@ pnpm run docs:build
- 管理员账号:`admin` 密码:`123456`
- 演示账号:`demo` 密码:`123456`

---

### docker 部署

```sh
Expand Down Expand Up @@ -244,8 +217,6 @@ fastapi_vue3_amdin/devops/devops/nginx/nginx.conf

```

---

## 🔧 模块展示

### web 端
Expand Down Expand Up @@ -279,8 +250,6 @@ fastapi_vue3_amdin/devops/devops/nginx/nginx.conf
| 登录 | ![移动端登录](./fastdocs/src/public/app_login.png) | 首页 | ![移动端首页](./fastdocs/src/public/app_home.png) | 我的 | ![移动端个人中心](./fastdocs/src/public/app_mine.png) |
| 个人 | ![移动端个人信息](./fastdocs/src/public/app_profile.png) | 设置 | ![移动端设置](./fastdocs/src/public/app_setting.png) | 工作台 | ![移动端工作台](./fastdocs/src/public/app_work.png) |

---

## 🛠️ 二开教程

### 后端部分
Expand All @@ -306,7 +275,15 @@ fastapi_vue3_amdin/devops/devops/nginx/nginx.conf
1. **移动端接入后端接口地址**:在 `fastapp/src/api` 中编写
2. **编写移动端页面**:在 `fastapp/src/pages` 中编写

---
## ℹ️ 帮助

更多详情请查看 [官方文档](https://service.fastapiadmin.com)

## 👥 贡献者

<a href="https://github.com/1014TaoTao/fastapi_vue3_admin/graphs/contributors">
<img src="https://contrib.rocks/image?repo=1014TaoTao/fastapi_vue3_admin"/>
</a>

## 🙏 特别鸣谢

Expand All @@ -329,8 +306,8 @@ fastapi_vue3_amdin/devops/devops/nginx/nginx.conf
| --- | --- | --- |
| ![微信二维码](./fastdocs/src/public/wechat.jpg) | ![群组二维码](./fastdocs/src/public/group.jpg) | ![微信支付二维码](./fastdocs/src/public/wechatPay.jpg) |

---

## ❤️ Star 支持我

如果你喜欢这个项目,请给我一个 ⭐️ Star 支持一下吧!非常感谢!

[![Stargazers over time](https://starchart.cc/1014TaoTao/fastapi_vue3_admin.svg?variant=adaptive)](https://starchart.cc/1014TaoTao/fastapi_vue3_admin)
Loading