跳到主要内容
Skip to content

🍪 演示环境

环境准备

类型技术栈版本
后端Python≥ 3.10(推荐 3.12)
后端FastAPI0.109+
前端Node.js≥ 20.0
前端pnpm≥ 9.0
Web UIElement Plus2.10+
移动端UniApp3.0+
App UIWot Design Uni1.9+
数据库MySQL8.0+ / PostgreSQL 13+ / SQLite
中间件Redis7.0+

获取代码

bash
git clone https://github.com/fastapiadmin/FastapiAdmin.git
# 或使用 Gitee
git clone https://gitee.com/fastapiadmin/FastapiAdmin.git

后端启动

1. 配置环境变量

bash
cd FastapiAdmin/backend
cp env/.env.dev.example env/.env.dev
# 编辑 env/.env.dev,填写数据库连接、Redis、JWT 密钥等

2. 安装依赖并启动

bash
# 推荐使用 uv(与 pyproject.toml 一致)
uv sync
uv run main.py run --env=dev

# 或使用传统 pip / venv
python -m venv .venv
source .venv/bin/activate          # Windows: .venv\Scripts\activate
pip install -r requirements.txt
python main.py run --env=dev

首次启动会自动初始化数据库表与基础数据,一般无需先执行 upgrade

3. 数据库迁移(模型变更时使用)

bash
python main.py revision --env=dev
python main.py upgrade --env=dev

# 或使用 uv
uv run main.py revision --env=dev
uv run main.py upgrade --env=dev

前端启动

bash
# Web 前端 (Vue3)
cd FastapiAdmin/frontend/web
pnpm install
pnpm run dev

# 移动端 (UniApp)
cd FastapiAdmin/frontend/app
pnpm install
pnpm run dev:h5

# 文档网站 (VitePress)
cd FastapiAdmin/frontend/docs
pnpm install
pnpm run dev

本地访问地址

服务地址
Web 前端http://127.0.0.1:5173
移动端 H5http://127.0.0.1:8080
文档网站http://127.0.0.1:5174
后端 APIhttp://127.0.0.1:8001
Swaggerhttp://127.0.0.1:8001/docs
API 前缀http://127.0.0.1:8001/api/v1

🐳 Docker 部署

详见 部署指南,快速命令:

bash
chmod +x deploy.sh
./deploy.sh              # 完整部署
./deploy.sh logs         # 查看日志
./deploy.sh stop         # 停止
./deploy.sh restart      # 重启

💡 常见问题

问题解答
后端启动报数据库连接失败确保已创建空数据库,.env.dev 中连接信息正确
前端请求后端报 CORS 错误确认后端已启动,.env.developmentVITE_API_BASE_URL 正确
首次启动需要执行迁移吗不需要——后端首次启动自动初始化表与数据
Node.js 版本不符使用 nvm 安装对应版本:nvm install 20