由于 trendforge.devlive.top 访问受限,请切换到 trendforge.devlive.org 域名

5分钟快速开始 vue-fastapi-admin

基于 FastAPI + Vue3 + Naive UI 的现代化轻量管理平台,包含 RBAC 权限管理、JWT 鉴权等功能。

环境要求

支持的操作系统

macOS Windows Linux

运行环境

Python 3.11 必需
Node.js v18.8.0+ 必需

所需工具

Git

克隆项目代码

必需
uv (推荐) 或 pip

Python 包管理

必需
pnpm (推荐) 或 npm/yarn

前端包管理

必需

操作步骤

1

克隆项目代码

从 GitHub 克隆项目到本地。

克隆仓库
git clone https://github.com/mizhexiaoxiao/vue-fastapi-admin.git
进入项目根目录
cd vue-fastapi-admin

预期结果::项目文件被下载到本地 vue-fastapi-admin 目录。

确保网络畅通,可以访问 GitHub。

2

启动后端服务 (FastAPI)

安装 Python 依赖并启动后端服务。

进入后端目录
cd backend
使用 uv 创建虚拟环境 (推荐)
uv venv
激活虚拟环境 (macOS/Linux)
source .venv/bin/activate
使用 uv 安装依赖
uv pip install -r requirements.txt
启动后端开发服务器
uvicorn app.main:app --reload --host 0.0.0.0 --port 8000

预期结果::看到类似 'Uvicorn running on http://0.0.0.0:8000' 的输出,表明后端服务已启动。

如果未安装 uv,可以使用 pip:创建虚拟环境 `python -m venv .venv`,激活后 `pip install -r requirements.txt`,然后启动。

3

启动前端服务 (Vue)

在新的终端窗口中安装前端依赖并启动开发服务器。

进入前端目录
cd frontend
使用 pnpm 安装依赖
pnpm install
启动前端开发服务器
pnpm dev

预期结果::看到类似 'Local: http://localhost:3000/' 的输出,表明前端服务已启动。

如果未安装 pnpm,可以使用 npm:`npm install` 然后 `npm run dev`。

验证成功

访问前端应用并登录。

浏览器打开 http://localhost:3000 能看到登录页面
使用默认账号 `admin` 和密码 `123456` 可以成功登录并看到工作台

快速提示

部署

项目同时提供了 Docker 快速启动方式,详见 README 中的 Docker 部分。

开发

后端 API 文档地址为 http://localhost:8000/docs

环境

前端开发服务器默认端口为 3000,后端为 8000,确保端口未被占用。

常见问题

1

后端启动失败,提示模块未找到。

确保已激活虚拟环境,并重新运行 `uv pip install -r requirements.txt` 或 `pip install -r requirements.txt`。

2

前端安装依赖失败。

尝试删除 `node_modules` 和 `package-lock.json` (或 `pnpm-lock.yaml`),然后重新运行 `pnpm install`。

3

浏览器访问页面显示连接被拒绝。

检查后端和前端服务是否都已成功启动,并确认它们分别运行在 8000 和 3000 端口。检查防火墙或安全软件是否拦截了连接。

下一步

探索项目代码

查看目录结构,了解 FastAPI 和 Vue3 的集成方式。

阅读官方文档

深入了解 FastAPI、Vue3、Naive UI 和 Tortoise-ORM。

自定义与扩展

尝试修改菜单、用户或角色,体验 RBAC 和动态路由功能。

助手