public/FastapiAdmin
1
0
Fork 0
mirror of https://github.com/fastapiadmin/FastapiAdmin.git synced 2026-09-20 20:39:55 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
de997715f0bf593a129e89ff6021737cebb515f9
FastapiAdmin/README.md
T
zhangtao b83dc42e2d refactor: 优化错误处理和消息提示机制 
- 移除前端冗余的错误消息提示，统一使用console.error记录错误
- 使用后端返回的msg作为成功提示消息
- 更新演示环境地址和API端口配置
- 清理缓存管理模块的冗余消息提示
- 改进认证错误提示信息，增加状态码
```

这个提交消息：
1. 使用refactor类型，因为主要是代码结构的优化而非功能修改
2. 概括了主要修改内容：错误处理和消息提示机制的优化
3. 在消息体中列出了具体修改点，包括：
   - 前端错误处理方式统一
   - 成功提示消息来源调整
   - 配置更新
   - 特定模块的清理
   - 认证提示改进
2025-05-29 22:42:37 +08:00

336 lines
12 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<p align="center">
<img src="https://capsule-render.vercel.app/api?type=waving&color=timeGradient&height=256&&section=header&text=Fastapi%20Vue3%20Admin&fontSize=90&fontAlign=50&fontAlignY=28&desc=一套现代、开源、全栈融合的中后台快速开发平台，给个⭐️支持一下%F0%9F%98%81&descAlign=50&descSize=0&descAlignY=56&animation=twinkling" />
</p>
<p align="center">
<img src="https://media.giphy.com/media/WUlplcMpOCEmTGBtBW/giphy.gif" width="200"/>
</p>
<p align="center">
<img width="700" src="https://readme-typing-svg.demolab.com?font=LXGW+WenKai+TC&size=25&pause=1000&center=true&vCenter=true&random=false&width=600&lines=欢迎来到我的GitHub主页！"/>
</p>
<p align="center">
<a href="https://gitee.com/tao__tao/fastapi_vue3_admin.git" target="_blank">
<img src="https://gitee.com/tao__tao/fastapi_vue3_admin/badge/star.svg?theme=dark" alt="Gitee Stars">
</a>
<a href="https://github.com/1014TaoTao/fastapi_vue3_admin.git" target="_blank">
<img src="https://img.shields.io/github/stars/1014TaoTao/fastapi_vue3_admin?style=social" alt="GitHub Stars">
</a>
<a href="https://gitee.com/tao__tao/fastapi_vue3_admin/blob/master/LICENSE" target="_blank">
<img src="https://img.shields.io/badge/License-MIT-orange" alt="License">
</a>
<img src="https://img.shields.io/badge/Python-≥3.10-blue">
<img src="https://img.shields.io/badge/NodeJS-≥20.0-blue">
<img src="https://img.shields.io/badge/MySQL-≥8.0-blue">
<img src="https://img.shields.io/badge/Redis-≥7.0-blue">
<img src="https://img.shields.io/badge/-HTML5-E34F26?style=flat-square&logo=html5&logoColor=white"/>
<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>
# 📊 GitHub 数据统计（作者：@1014TaoTao）
<table align="center">
<tr>
<td>
<img height="200px" width="auto" src="https://github-readme-stats.vercel.app/api?username=1014TaoTao&show_icons=true&theme=dracula">
</td>
<td>
<img height="200px" width="auto" src="https://github-readme-stats.vercel.app/api/top-langs/?username=1014TaoTao&layout=compact&theme=dracula">
</td>
<td>
<img height="200px" width="auto" src="https://github-readme-streak-stats.herokuapp.com/?user=1014TaoTao&theme=dracula">
</td>
</tr>
</table>
<p align="center">
<img src="https://github-readme-activity-graph.vercel.app/graph?username=1014TaoTao&theme=dracula&hide_border=true&area=true&custom_title=Activity%20Graph" alt="Activity Graph" title="Activity Graph" />
</p>
---
简体中文 | [English](./README.en.md)
---
## 📘 项目介绍
**Fastapi-Vue3-Admin** 是一套 **完全开源、高度模块化、技术先进的现代化快速开发平台**，旨在帮助开发者高效搭建高质量的企业级中后台系统。该项目采用 **前后端分离架构**，融合 Python 后端框架 `FastAPI` 和前端主流框架 `Vue3`，结合 `UniApp` 实现多端统一开发，提供了一站式开箱即用的开发体验。
> **设计初心**: 以模块化、松耦合为核心，追求丰富的功能模块、简洁易用的接口、详尽的开发文档和便捷的维护方式。通过统一框架和组件，降低技术选型成本，遵循开发规范和设计模式，构建强大的代码分层模型，搭配完善的本地中文化支持，专为团队和企业开发场景量身定制。
```sh
fastapi_vue3_admin
├─ backend # 后端工程
├─ frontend # 前端工程
├─ devops # 部署工程
├─ uni-app # 移动端工程
├─ docker-compose.yaml # 部署文件
├─ start.sh # 一键部署脚本
├─ LICENSE # 许可协议
|─ README.en.md # 英文文档
└─ README.md # 中文文档
```
---
## ✨ 核心亮点
| 特性 | 描述 |
| ---- | ---- |
| 🔭 快速开发 |一套完全开源的现代化快速开发平台，旨在帮助开发者高效搭建高质量的中后台系统。|
| 🌐 全栈整合 | 前后端分离，融合 Python (FastAPI) + Vue3 + UniApp 多端开发 |
| 🧱 模块化设计 | 系统功能高度解耦，便于扩展和维护 |
| ⚡️ 高性能异步 | 使用 FastAPI 异步框架 + Redis 缓存优化接口响应速度 |
| 🔒 安全认证 | 支持 JWT OAuth2 认证机制，保障系统安全 |
| 📊 权限管理 | RBAC 模型实现菜单、按钮、数据级别的细粒度权限控制 |
| 🚀 快速部署 | 支持 Docker/Docker Compose/Nginx 一键部署 |
| 📄 开发友好 | 提供完善的中文文档 + 中文化界面 + 可视化工具链，降低学习成本 |
| 📫 跨平台支持 | 通过 UniApp 支持多端开发，包括 H5、小程序等。|
| 🚀 快速接入 |基于 Vue3、Vite5、Pinia、UniApp、Ant Design Vue、uView-plus 等主流前端技术栈，开箱即用。|
---
## 🛠️ 技术栈概览
| 类型 | 技术选型 | 描述 |
|----------|---------------------|---------------------|
| 后端框架 | FastAPI / Uvicorn / Pydantic 2.0 / Alembic | 现代、高性能的异步框架，强制类型约束，数据迁移。 |
| ORM | SQLAlchemy 2.0 | 强大的 ORM 库。 |
| 定时任务 | APScheduler | 轻松实现定时任务。 |
| 权限认证 | PyJWT | 实现 JWT 认证。 |
| 前端框架 | Vue3 / Vite5 / Pinia / TypeScript | 快速开发 Vue3 应用。 |
| UI 库 | Ant Design Vue / uView-plus | 快速开发美观的 UI 组件。 |
| 移动端 | UniApp | 快速开发移动端应用。 |
| 数据库 | MySQL / MongoDB | 强大的数据库。 |
| 缓存 | Redis | 强大的缓存数据库。 |
| 文档 | Swagger / Redoc | 自动生成 API 文档。 |
| 部署 | Docker / Nginx / Docker Compose | 快速部署项目。 |
---
## 📌 内置模块
| 模块名 | 子模块名 | 描述 |
|----------|---------------------|---------------------|
| 仪表盘 | 工作台 、分析页 |常用功能入口 |
| 系统管理 | 包含菜单、部门、岗位、角色、用户、日志、配置、公告、字典、任务等子模块|系统主功能 |
| 监控管理 | 在线用户、服务器监控、缓存监控 |系统监控管理功能 |
| 公共管理 | 接口管理、文档管理|项目接口文档 |
| App 端 | 首页、工作台、个人中心|移动端应用管理 |
---
## 🍪 演示环境
- 演示地址：<http://service.fastapiadmin.com>
- 管理员账号：`admin` 密码：`123456`
- 演示账号：`demo` 密码：`123456`
---
## 👷 安装和使用
### 版本说明
| 类型 | 技术栈 | 版本 |
|----------|------------|------------|
| 后端 | Python | 3.10（大于3.10的版本, 会有兼容问题, 将来升级，暂时不考虑升级） |
| 后端 | FastAPI | 0.109 |
| 前端 | Node.js | >= 20.0（推荐使用最新版）|
| 前端 | npm | 16.14 |
| 前端 | Vue3 | 3.3 |
| 数据库 | MySQL | 8.0 （推荐使用最新版）|
| 中间件 | Redis | 7.0 （推荐使用最新版）|
| 小程序 | uni-app | 3.0.0 |
| 小程序 | uview-plus | ^3.3.74 |
---
### 获取代码
```sh
# 克隆代码到本地
git clone https://gitee.com/tao__tao/fastapi_vue3_admin.git
或
git clone https://github.com/1014TaoTao/fastapi_vue3_admin.git
```
---
### 本地后端启动
```sh
# 进入后端工程目录
cd backend
# 安装依赖
pip3 install -r requirements.txt
# 启动后端服务
python3 main.py run
或
python3 main.py run--env=dev
# 生成迁移文件
python3 main.py revision "初始化迁移" --env=dev(不加默认为dev)
# 应用迁移
python3 main.py upgrade --env=dev(不加默认为dev)
```
---
### 本地前端启动
```sh
# 进入前端工程目录
cd frontend
# 安装依赖
npm install
# 启动前端服务
npm run dev
# 构建前端, 生成 `frontend/dist` 目录
npm run build
```
---
### 本地小程序启动
```sh
# 进入移动工程目录
cd uni-app
# 安装依赖
npm install
# 启动小程序
npm run dev:h5
# 构建, 生成 `uni-app/dist` 目录
npm run build
```
---
### 本地访问地址
- 前端地址: <http://127.0.0.1:5180>
- 小程序地址: <http://127.0.0.1:5181>
- 接口地址: <http://127.0.0.1:8001/api/v1/docs>
- 管理员账号：`admin` 密码：`123456`
- 演示账号：`demo` 密码：`123456`
---
### docker 部署
```sh
# 复制脚本 `fastapi_vue3_amdin/start.sh` 脚本文件到服务器, 并赋予执行权限
chmod +x start.sh
# 执行脚本
./start.sh
# 访问地址
# 前端访问: `http://公网地址:80`,
# 接口访问: `http://公网地址:8001/api/v1/docs`，
# 登录 `admin/123456` 或 `demo/123456`
# 查看镜像:
docsker images -a
# 查看容器:
docsker compose ps
# 查看日志
docker logs -f <容器名>
# 服务停止
docsker compose down
# 删除镜像
docker rmi <镜像名>
# 删除容器
docker rm <容器名>
```
- **部署问题排查**:
- 后端配置文件 `fastapi_vue3_amdin/backend/env/.env.prod.py`
- 前端配置文件 `fastapi_vue3_amdin/frontend/vite.config.ts` 和 `fastapi_vue3_amdin/frontend/.env.production`
- 部署文件 `fastapi_vue3_amdin/docker-compose.yaml` 和 `fastapi_vue3_amdin/devops/devops/nginx/nginx.conf`
---
## 🔧 模块展示
<table>
<tr>
<td><img src="./backend/docs/resources/login.png"/>登陆</td>
<td><img src="./backend/docs/resources/dashboard.png"/>仪表盘</td>
<td><img src="./backend/docs/resources/menu.png"/>菜单管理</td>
<td><img src="./backend/docs/resources/dept.png"/>部门管理</td>
</tr>
<tr>
<td><img src="./backend/docs/resources/position.png"/>岗位管理</td>
<td><img src="./backend/docs/resources/role.png"/>角色管理</td>
<td><img src="./backend/docs/resources/user.png"/>用户管理</td>
<td><img src="./backend/docs/resources/log.png"/>日志管理</td>
</tr>
<tr>
<td><img src="./backend/docs/resources/config.png"/>配置管理</td>
<td><img src="./backend/docs/resources/online.png"/>在线用户管理</td>
<td><img src="./backend/docs/resources/service.png"/>服务器监控</td>
<td><img src="./backend/docs/resources/cache.png"/>缓存监控</td>
</tr>
<tr>
<td><img src="./backend/docs/resources/job.png"/>任务管理</td>
<td><img src="./backend/docs/resources/docs.png"/>接口管理</td>
<td><img src="./backend/docs/resources/redoc.png"/>文档管理</td>
<td><img src="./backend/docs/resources/info.png"/>个人信息</td>
</tr>
</tr>
<td><img src="./backend/docs/resources/help.png"/>在线文档</td>
<td><img src="./backend/docs/resources/dict.png"/>字典管理</td>
</tr>
<tr>
<td><img src="./backend/docs/resources/app-login.png"/>app登陆</td>
<td><img src="./backend/docs/resources/app-home.png"/>app首页</td>
<td><img src="./backend/docs/resources/app-work.png"/>app工作台</td>
<td><img src="./backend/docs/resources/app-me.png"/>app个人中心</td>
</tr>
</table>
---
## 🙏 特别鸣谢
感谢以下项目的贡献和支持，使本项目得以顺利完成：
- [FastAPI 项目](https://fastapi.tiangolo.com/)
- [Vue3 项目](https://v3.cn.vuejs.org/)
- [KInit 项目](https://gitee.com/ktianc/kinit)
- [Fastapi-Vue3-Admin 项目](https://gitee.com/senqi666/fastapi-vue-admin)
- [Vue-FastAPI-Admin 项目](https://gitee.com/mizhexiaoxiao/vue-fastapi-admin)
- [RuoYi-Vue3-FastAPI 项目](https://gitee.com/insistence2022/RuoYi-Vue3-FastAPI)
- [APScheduler 项目](https://github.com/agronholm/apscheduler)
- [Vite 项目](https://github.com/vitejs/vite)
- [UniApp 项目](https://github.com/dcloudio/uni-app)
- [uView-plus 项目](https://uiadmin.net/uview-plus)
---
## 🎨 社区
<table>
<tr>
<td><img src="./backend/docs/resources/wechat.jpg"/></td>
<td><img src="./backend/docs/resources/group.jpg"/></td>
<td><img src="./backend/docs/resources/wechatPay.jpg"/></td>
</tr>
</table>
---
## ❤️ Star 支持我
如果你喜欢这个项目，请给我一个 ⭐️ Star 支持一下吧！非常感谢！
---
## 👀 访问统计
![Visitor Count](https://profile-counter.glitch.me/1014TaoTao/count.svg)
---
<p align="center">
<img src="https://capsule-render.vercel.app/api?type=waving&color=timeGradient&height=260&&section=footer&text=感谢&fontSize=90&fontAlign=50&fontAlignY=78&desc=给个%20star ⭐️ %20不过分吧&descAlign=50&descSize=30&descAlignY=46&animation=twinkling" />
</p>
Reference in New Issue View Git Blame Copy Permalink