Files
FastapiAdmin/README.md
T
zhangtao 94ba7319c5 docs: 完善项目文档与目录结构
1. 新增并更新各模块README文档,统一项目说明格式
2. 调整docker目录结构,使用.gitkeep保留空目录
3. 新增CONTRIBUTING.md贡献指南文档
4. 精简根目录README,优化导航与展示逻辑
2026-05-22 00:34:08 +08:00

6.3 KiB
Raw Blame History

logo

FastApiAdmin v2.0.0

🚀 开箱即用,5 分钟搭建企业级中后台

基于 FastAPI + Vue3 + TypeScript 的全栈快速开发平台,Web / H5 / 小程序一站式交付

Gitee Stars GitHub Stars GitHub Forks
License

简体中文 | English

💡 为什么选择 FastapiAdmin

你需要的 FastapiAdmin Django Admin 纯前端模板
🎯 开箱即用的后台系统 ⚠️ 功能有限 只有 UI
FastAPI 异步高性能后端 同步为主 无后端
🔐 RBAC 菜单/按钮/数据三级权限 基础
🤖 代码生成器(选表 → 出前后端代码)
📱 移动端H5 + 小程序)一体
🐳 Docker 一键部署(含 Nginx + SSL

👉 详细技术选型对比:为什么选择 FastapiAdmin

🍪 在线体验

地址 账号
💻 Web 端 service.fastapiadmin.com/web admin / 123456
📱 移动端 service.fastapiadmin.com/app admin / 123456
📖 官方文档 service.fastapiadmin.com 无需登录

🚀 5 分钟本地跑起来

# 1. 克隆
git clone https://gitee.com/fastapiadmin/FastapiAdmin.git

# 2. 配置环境
cp backend/env/.env.dev.example backend/env/.env.dev
cp frontend/web/.env.development.example frontend/web/.env.development

# 3. 启动后端(首次自动建表 + 初始化数据)
cd backend && uv sync && uv run main.py run --env=dev

# 4. 启动前端
cd ../frontend/web && pnpm install && pnpm run dev

# ✅ 浏览器打开 http://127.0.0.1:5173,用 admin/123456 登录
环境要求
Python ≥ 3.10(推荐 3.12 Node.js ≥ 20.0 + pnpm
MySQL 8.0+ / PostgreSQL 14+ Redis 6.x / 7.x

📦 工程结构

FastapiAdmin/            # Monorepo 全栈工程
├─ backend/              # FastAPI 后端(Pydantic 2.0 + SQLAlchemy + Alembic
├─ frontend/
│   ├── web/             # Vue3 Web 前端(Element Plus + TypeScript
│   ├── app/             # UniApp 移动端(H5 + 小程序 + App
│   └── docs/            # VitePress 文档网站
├─ docker/               # Docker Compose 一键部署(Nginx + SSL
├─ deploy.sh             # 一键部署脚本
└─ LICENSE               # MIT 开源协议

📌 内置功能(开箱即用)

模块 包含能力
📊 仪表盘 工作台、数据分析
⚙️ 系统管理 用户 / 角色 / 菜单 / 部门 / 岗位 / 字典 / 配置 / 公告
👀 监控管理 在线用户 / 服务器监控 / 缓存监控
📋 任务管理 定时任务调度
📝 日志管理 操作日志审计
🧰 开发工具 代码生成、表单构建、接口文档
📁 文件管理 统一文件管理
🤖 智能体 基于 Agno 的智能体框架

🔧 截图展示

登录 仪表盘 代码生成 AI 助手
登录 仪表盘 代码生成 AI

📖 文档地址

🤝 参与贡献

欢迎提交 Issue / PR!详见 贡献指南

👥 社区与支持

微信群 赞赏支持
群组二维码 微信支付

如果你觉得项目有用,请给一个 Star 支持!

Stargazers over time

👥 贡献者

🙏 鸣谢