Skip to content

Commit 5b46f00

Browse files
fastapiadminfastapiadmin
authored
Merge pull request #175 from 1014TaoTao/v2.0.0
V2.0.0
2 parents 9e7fdb3 + 60fe97a commit 5b46f00

91 files changed

Lines changed: 2138 additions & 1487 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎README.en.md‎

Lines changed: 15 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -23,21 +23,19 @@
2323
<img src="https://img.shields.io/badge/-CSS3-1572B6?style=flat-square&logo=css3"/>
2424
<img src="https://img.shields.io/badge/-JavaScript-563D7C?style=flat-square&logo=bootstrap"/>
2525
</p>
26-
</div>
27-
28-
---
2926

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

32-
---
29+
</div>
3330

34-
## 📘 Project Introduction (Author: @1014TaoTao)
31+
## 📘 Project Introduction
3532

3633
**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.
3734

3835
> **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.
3936
4037
## 📦Engineering Structures
38+
4139
```sh
4240
fastapi_vue3_admin
4341
├─ backend # Backend project
@@ -52,8 +50,6 @@ fastapi_vue3_admin
5250
└─ README.md # Chinese documentation
5351
```
5452

55-
---
56-
5753
## ✨ Core Highlights
5854

5955
| Feature | Description |
@@ -68,8 +64,6 @@ fastapi_vue3_admin
6864
| 📄 Developer-friendly | Provides comprehensive Chinese documentation, a Chinese interface, and a visual toolchain to reduce the learning curve. |
6965
| 🧩 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. |
7066

71-
---
72-
7367
## 🛠️ Technology Stack Overview
7468

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

88-
---
89-
9082
## 📌 Built-in Modules
9183

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

99-
---
100-
10191
## 🍪 Demo Environment
10292

10393
- Official website: <https://service.fastapiadmin.com>
10494
- Web address: <https://service.fastapiadmin.com/web>
10595
- App address: <https://service.fastapiadmin.com/app>
106-
- Admin account: `admin` Password: `123456`
107-
- Demo account: `demo` Password: `123456`
108-
109-
---
96+
- Account: `admin` Password: `123456`
11097

11198
## 👷 Installation and Usage
11299

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

128-
---
129-
130115
### Get Code
131116

132117
```sh
@@ -136,8 +121,6 @@ git clone https://gitee.com/tao__tao/fastapi_vue3_admin.git
136121
git clone https://github.com/1014TaoTao/fastapi_vue3_admin.git
137122
```
138123

139-
---
140-
141124
### Local Backend Start
142125

143126
```sh
@@ -155,8 +138,6 @@ python3 main.py revision "Initial migration" --env=dev (default is dev if not sp
155138
python3 main.py upgrade --env=dev (default is dev if not specified)
156139
```
157140
158-
---
159-
160141
### Local Frontend Start
161142
162143
```sh
@@ -170,8 +151,6 @@ pnpm run dev
170151
pnpm run build
171152
```
172153
173-
---
174-
175154
### Local App H5 Start
176155
177156
```sh
@@ -185,8 +164,6 @@ pnpm run dev:h5
185164
pnpm run build:h5
186165
```
187166
188-
---
189-
190167
### Local Project Website Start
191168
192169
```sh
@@ -200,8 +177,6 @@ pnpm run docs:dev
200177
pnpm run docs:build
201178
```
202179
203-
---
204-
205180
### Local Access Address
206181
207182
- Project official website address: <http://localhost:5180>
@@ -210,8 +185,6 @@ pnpm run docs:build
210185
- Admin account: `admin` Password: `123456`
211186
- Demo account: `demo` Password: `123456`
212187
213-
---
214-
215188
### Docker Build
216189
217190
```sh
@@ -244,8 +217,6 @@ fastapi_vue3_admin/devops/devops/nginx/nginx.conf
244217

245218
```
246219
247-
---
248-
249220
## 🔧 Models
250221
251222
| Module | Screenshot |
@@ -270,13 +241,12 @@ fastapi_vue3_admin/devops/devops/nginx/nginx.conf
270241
| Document | ![Document](./fastdocs/src/public/help.png) |
271242
| Lock | ![Lock](./fastdocs/src/public/lock.png) |
272243
273-
### 移动端
244+
### Mobile
274245
275246
| Module <div style="width:60px"/> | Details | Module <div style="width:60px"/> | Details | Module <div style="width:60px"/> | Details |
276247
|----------|------|----------|------|----------|------|
277248
| 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) |
278249
| 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) |
279-
---
280250
281251
## 🛠️ Secondary Development Tutorial
282252
@@ -303,8 +273,15 @@ fastapi_vue3_admin/devops/devops/nginx/nginx.conf
303273
1. **Configure the mobile access address for backend interfaces**: Write the code in `fastapp/src/api`.
304274
2. **Write mobile pages**: Write the code in `fastapp/src/pages`.
305275
276+
## ℹ️ Help
277+
278+
For more details, please check the [Official Documentation](https://service.fastapiadmin.com)
279+
280+
## 👥 Contributors
306281
307-
---
282+
<a href="https://github.com/1014TaoTao/fastapi_vue3_admin/graphs/contributors">
283+
<img src="https://contrib.rocks/image?repo=1014TaoTao/fastapi_vue3_admin"/>
284+
</a>
308285
309286
## 🙏 Thanks
310287
@@ -321,16 +298,14 @@ Thanks to the contributions and support of the following projects, which have en
321298
- [Vue3-element-admin Project](https://gitee.com/youlaiorg/vue3-element-admin)
322299
- [Vue3-element-plus-admin Project](https://gitee.com/kailong110120130/vue-element-plus-admin)
323300
324-
---
325-
326301
## 🎨 Community
327302
328303
| WeChat QR Code | Group QR Code | WeChat Pay QR Code |
329304
| --- | --- | --- |
330305
| ![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) |
331306
332-
---
333-
334307
## ❤️ Star
335308
336309
If you like this project, please give it a ⭐️ Star to show your support! Thank you very much!
310+
311+
[![Stargazers over time](https://starchart.cc/1014TaoTao/fastapi_vue3_admin.svg?variant=adaptive)](https://starchart.cc/1014TaoTao/fastapi_vue3_admin)

‎README.md‎

Lines changed: 15 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -23,21 +23,19 @@
2323
<img src="https://img.shields.io/badge/-CSS3-1572B6?style=flat-square&logo=css3"/>
2424
<img src="https://img.shields.io/badge/-JavaScript-563D7C?style=flat-square&logo=bootstrap"/>
2525
</p>
26-
</div>
27-
28-
---
2926

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

32-
---
29+
</div>
3330

34-
## 📘 项目介绍（作者：@1014TaoTao）
31+
## 📘 项目介绍
3532

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

3835
> **设计初心**: 以模块化、松耦合为核心，追求丰富的功能模块、简洁易用的接口、详尽的开发文档和便捷的维护方式。通过统一框架和组件，降低技术选型成本，遵循开发规范和设计模式，构建强大的代码分层模型，搭配完善的本地中文化支持，专为团队和企业开发场景量身定制。
3936
4037
## 📦工程结构概览
38+
4139
```sh
4240
fastapi_vue3_admin
4341
├─ backend # 后端工程
@@ -52,8 +50,6 @@ fastapi_vue3_admin
5250
└─ README.md # 中文文档
5351
```
5452

55-
---
56-
5753
## ✨ 核心亮点
5854

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

71-
---
72-
7367
## 🛠️ 技术栈概览
7468

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

88-
---
89-
9082
## 📌 内置模块
9183

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

99-
---
100-
10191
## 🍪 演示环境
10292

10393
- 官网地址：<https://service.fastapiadmin.com>
10494
- 演示地址：<https://service.fastapiadmin.com/web>
10595
- 小程序地址：<https://service.fastapiadmin.com/app>
106-
- 管理员账号：`admin` 密码：`123456`
107-
- 演示账号：`demo` 密码：`123456`
108-
109-
---
96+
- 登录账号：`admin` 密码：`123456`
11097

11198
## 👷 安装和使用
11299

@@ -125,8 +112,6 @@ fastapi_vue3_admin
125112
| 数据库 | MySQL | 8.0 （推荐使用最新版）|
126113
| 中间件 | Redis | 7.0 （推荐使用最新版）|
127114

128-
---
129-
130115
### 获取代码
131116

132117
```sh
@@ -136,8 +121,6 @@ git clone https://gitee.com/tao__tao/fastapi_vue3_admin.git
136121
git clone https://github.com/1014TaoTao/fastapi_vue3_admin.git
137122
```
138123

139-
---
140-
141124
### 本地后端启动
142125

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

158-
---
159-
160141
### 本地前端启动
161142

162143
```sh
@@ -170,8 +151,6 @@ pnpm run dev
170151
pnpm run build
171152
```
172153

173-
---
174-
175154
### 本地小程序h5启动
176155

177156
```sh
@@ -185,8 +164,6 @@ pnpm run dev:h5
185164
pnpm run build:h5
186165
```
187166

188-
---
189-
190167
### 本地项目官网启动
191168

192169
```sh
@@ -200,8 +177,6 @@ pnpm run docs:dev
200177
pnpm run docs:build
201178
```
202179

203-
---
204-
205180
### 本地访问地址
206181

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

213-
---
214-
215188
### docker 部署
216189

217190
```sh
@@ -244,8 +217,6 @@ fastapi_vue3_amdin/devops/devops/nginx/nginx.conf
244217

245218
```
246219

247-
---
248-
249220
## 🔧 模块展示
250221

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

282-
---
283-
284253
## 🛠️ 二开教程
285254

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

309-
---
278+
## ℹ️ 帮助
279+
280+
更多详情请查看 [官方文档](https://service.fastapiadmin.com)
281+
282+
## 👥 贡献者
283+
284+
<a href="https://github.com/1014TaoTao/fastapi_vue3_admin/graphs/contributors">
285+
<img src="https://contrib.rocks/image?repo=1014TaoTao/fastapi_vue3_admin"/>
286+
</a>
310287

311288
## 🙏 特别鸣谢
312289

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

332-
---
333-
334309
## ❤️ Star 支持我
335310

336311
如果你喜欢这个项目，请给我一个 ⭐️ Star 支持一下吧！非常感谢！
312+
313+
[![Stargazers over time](https://starchart.cc/1014TaoTao/fastapi_vue3_admin.svg?variant=adaptive)](https://starchart.cc/1014TaoTao/fastapi_vue3_admin)

0 commit comments

Comments
 (0)