public/FastapiAdmin
1
0
Fork 0
mirror of https://github.com/fastapiadmin/FastapiAdmin.git synced 2026-09-21 04:46:26 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
2ee4be963720cedaea38ca421171f6ebff643bb7
FastapiAdmin/README.en.md
T
zhangtao 0dbbe5cbcb feat: 添加多语言支持及资源文件更新 
- 添加日语、中文、泰语等多语言支持文件
- 更新静态资源文件包括图片和样式表
- 重构菜单权限树组件，修复父子节点联动问题
- 优化在线用户管理功能，使用会话ID替代用户名
- 更新数据库配置，默认使用MySQL
- 重构文档系统，将mkdocs迁移至backend目录
- 修复Redis哈希操作接口
- 更新前端工具函数，优化列表转树形结构逻辑
- 调整端口配置和环境变量
- 添加开发运维文档和部署脚本

本次提交主要实现了多语言支持、资源文件更新和多个功能优化，同时改进了系统文档结构和部署配置。
2025-05-26 00:36:34 +08:00

351 lines
15 KiB
Markdown
Raw Blame History

<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=A modern, open-source, full-stack integrated rapid development platform for middle and back-office applications, give us a ⭐️ to show your support!%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=Welcome to my GitHub homepage!"/>
</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 Data Statistics (Author: @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 | [Chinese](./README.md)
---
## 📘 Project Introduction
**Fastapi-Vue3-Admin** is a **fully open-source, highly modular, and technologically advanced modern rapid development platform**, designed to help developers efficiently build high-quality enterprise-level middle and back-office systems. This project adopts a **front-end and back-end decoupled architecture**, integrating the Python backend framework `FastAPI` and the mainstream frontend framework `Vue3`, combined with `UniApp` to achieve unified multi-terminal development, providing an all-in-one, out-of-the-box development experience.
> **Design Philosophy**: Centered around modularity and loose coupling, it aims to offer rich functional modules, simple and easy-to-use interfaces, comprehensive development documentation, and convenient maintenance methods. By leveraging a unified framework and components, it reduces technology selection costs, follows development specifications and design patterns, builds a robust code layering model, and is equipped with comprehensive localized Chinese support—specifically tailored for team and enterprise development scenarios.
```sh
fastapi_vue3_admin
├─ backend # Backend project
├─ frontend # Frontend project
├─ devops # Deployment project
├─ uni-app # Mobile application project
├─ docker-compose.yaml # Deployment configuration file
├─ start.sh # One-click deployment script
├─ LICENSE # License agreement
├─ README.en.md # English documentation
└─ README.md # Chinese documentation
```
---
## ✨ Core Highlights
| Feature | Description |
| ------ | ----------- |
| 🔭 Rapid Development | A fully open-source modern rapid development platform designed to help developers efficiently build high-quality middle and back-office systems. |
| 🌐 Full-Stack Integration | Frontend and backend decoupled architecture, integrating Python (FastAPI), Vue3, and UniApp for multi-terminal development. |
| 🧱 Modular Design | Highly decoupled system functions, easy to extend and maintain. |
| ⚡ High-Performance Asynchronous | Optimized interface response speed using the FastAPI asynchronous framework and Redis caching. |
| 🔒 Secure Authentication | Supports JWT OAuth2 authentication mechanisms to ensure system security. |
| 📊 Permission Management | Implements fine-grained permission control at the menu, button, and data levels using the RBAC model. |
| 🚀 Quick Deployment | Supports one-click deployment with Docker, Docker Compose, and Nginx. |
| 📄 Developer-Friendly | Provides comprehensive Chinese documentation, localized interface, and visual toolchains to reduce learning costs. |
| 📫 Cross-Platform Support | Supports multi-terminal development via UniApp, including H5 and mini-programs. |
| 🚀 Easy Integration | Ready-to-use with mainstream frontend technology stacks such as Vue3, Vite5, Pinia, UniApp, Ant Design Vue, and uView-plus. |
---
## 🛠️ Technology Stack Overview
| Type | Technology Selection | Description |
|--------------|------------------------------------------|--------------------------------------------------|
| Backend Framework | FastAPI / Uvicorn / Pydantic 2.0 / Alembic | Modern, high-performance asynchronous framework with strict type constraints and data migration support. |
| ORM | SQLAlchemy 2.0 | Powerful ORM library. |
| Task Scheduling | APScheduler | Easily implement scheduled tasks. |
| Authentication | PyJWT | Implements JWT-based authentication. |
| Frontend Framework | Vue3 / Vite5 / Pinia / TypeScript | Rapid development of Vue3 applications. |
| UI Library | Ant Design Vue / uView-plus | Quickly build visually appealing UI components. |
| Mobile Development | UniApp | Rapid mobile application development. |
| Database | MySQL / MongoDB | Powerful database systems. |
| Caching | Redis | High-performance caching database. |
| Documentation | Swagger / Redoc | Automatically generates API documentation. |
| Deployment | Docker / Nginx / Docker Compose | Rapid project deployment. |
---
## 📌 Built-in Modules
| Module Name | Submodules | Description |
|-----------------|-------------------------------------|----------------------------------|
| Dashboard | Workspace, Analytics Page | Common functional entry points |
| System Management | Menus, Departments, Positions, Roles, Users, Logs, Configurations, Announcements, Dictionaries, Tasks | Core system functionality |
| Monitoring Management | Online Users, Server Monitoring, Cache Monitoring | System monitoring and management features |
| Public Management | API Management, Documentation Management | Project API documentation management |
| App Module | Home Page, Workspace, Personal Center | Mobile application management |
---
## 🍪 Demo Environment
- **Demo URL**: <http://8.137.99.5>
- **Admin Account**: `admin` / Password: `123456`
- **Demo Account**: `demo` / Password: `123456`
---
## 👷 Installation and Usage
### Version Details
| Type | Technology Stack | Version |
|------------|------------------|-----------------------------------------|
| Backend | Python | 3.10 (Versions above 3.10 may cause compatibility issues; upgrade is not planned for now) |
| Backend | FastAPI | 0.109 |
| Frontend | Node.js | >= 20.0 (latest version recommended) |
| Frontend | npm | 16.14 |
| Frontend | Vue3 | 3.3 |
| Database | MySQL | 8.0 (latest version recommended) |
| Middleware | Redis | 7.0 (latest version recommended) |
| MiniApp | uni-app | 3.0.0 |
| MiniApp | uview-plus | ^3.3.74 |
---
### Getting the Code
```sh
# Clone Code to Local Machine
git clone https://gitee.com/tao__tao/fastapi_vue3_admin.git
or
git clone https://github.com/1014TaoTao/fastapi_vue3_admin.git
```
### Local Backend Startup
```sh
# Navigate to the backend project directory
cd backend
# Install dependencies
pip3 install -r requirements.txt
# Start the backend service
python3 main.py run
or
python3 main.py run --env=dev
# Generate migration file (default environment is 'dev' if not specified)
python3 main.py revision "Initial migration" --env=dev
# Apply migration (default environment is 'dev' if not specified)
python3 main.py upgrade --env=dev
```
---
### Local Frontend Startup
```sh
# 进入前端工程目录
cd frontend
# 安装依赖
npm install
# 启动前端服务
npm run dev
# 构建前端, 生成 `frontend/dist` 目录
npm run build
```
---
### Local App Startup
```sh
# Navigate to the frontend project directory
cd frontend
# Install dependencies
npm install
# Start the frontend service
npm run dev
# Build the frontend, generating the `frontend/dist` directory
npm run build
```
---
### Local Access Addresses
- Frontend Address: <http://127.0.0.1:5180>
- Mini Program Address: <http://127.0.0.1:5181>
- API Address: <http://127.0.0.1:8080/api/v1/docs>
- Admin Account: `admin` Password: `123456`
- Demo Account: `demo` Password: `123456`
---
### Docker Deployment
```sh
# Copy the script `fastapi_vue3_amdin/start.sh` to the server and grant execution permissions
chmod +x start.sh
# Execute the script
./start.sh
# Access addresses
# Frontend access: `http://Public IP address:80`,
# API access: `http://Public IP address:8001/api/v1/docs`,
# Log in with `admin/123456` or `demo/123456`
# View images:
docker images -a
# View containers:
docker compose ps
# View logs
docker logs -f <Container name>
# Stop the service
docker compose down
# Delete an image
docker rmi <Image name>
# Delete a container
docker rm <Container name>
```
- **Deployment Issue Troubleshooting**:
- Backend configuration file `fastapi_vue3_admin/backend/env/.env.prod.py`
- Frontend configuration files `fastapi_vue3_admin/frontend/vite.config.ts` and `fastapi_vue3_admin/frontend/.env.production`
- Deployment files `fastapi_vue3_admin/docker-compose.yaml` and `fastapi_vue3_admin/devops/devops/nginx/nginx.conf`
---
## 🔧 Module Display
<table>
<tr>
<td><img src="./backend/docs/resources/login.png"/>Login</td>
<td><img src="./backend/docs/resources/dashboard.png"/>Dashboard</td>
<td><img src="./backend/docs/resources/menu.png"/>Menu Management</td>
<td><img src="./backend/docs/resources/dept.png"/>Department Management</td>
</tr>
<tr>
<td><img src="./backend/docs/resources/position.png"/>Position Management</td>
<td><img src="./backend/docs/resources/role.png"/>Role Management</td>
<td><img src="./backend/docs/resources/user.png"/>User Management</td>
<td><img src="./backend/docs/resources/log.png"/>Log Management</td>
</tr>
<tr>
<td><img src="./backend/docs/resources/config.png"/>Configuration Management</td>
<td><img src="./backend/docs/resources/online.png"/>Online User Management</td>
<td><img src="./backend/docs/resources/service.png"/>Server Monitoring</td>
<td><img src="./backend/docs/resources/cache.png"/>Cache Monitoring</td>
</tr>
<tr>
<td><img src="./backend/docs/resources/job.png"/>Task Management</td>
<td><img src="./backend/docs/resources/docs.png"/>API Management</td>
<td><img src="./backend/docs/resources/redoc.png"/>Documentation Management</td>
<td><img src="./backend/docs/resources/info.png"/>Personal Information</td>
</tr>
<tr>
<td><img src="./backend/docs/resources/help.png"/>Online Documentation</td>
<td><img src="./backend/docs/resources/dict.png"/>Dictionary Management</td>
</tr>
<tr>
<td><img src="./backend/docs/resources/app-login.png"/>App Login</td>
<td><img src="./backend/docs/resources/app-home.png"/>App Home Page</td>
<td><img src="./backend/docs/resources/app-work.png"/>App Workspace</td>
<td><img src="./backend/docs/resources/app-me.png"/>App Personal Center</td>
</tr>
</table>
---
## 🙏 Special Thanks
Thanks to the contributions and support of the following projects, which have enabled the successful completion of this project:
- [FastAPI Project](https://fastapi.tiangolo.com/)
- [Vue3 Project](https://v3.cn.vuejs.org/)
- [KInit Project](https://gitee.com/ktianc/kinit)
- [Fastapi-Vue3-Admin Project](https://gitee.com/senqi666/fastapi-vue-admin)
- [Vue-FastAPI-Admin Project](https://gitee.com/mizhexiaoxiao/vue-fastapi-admin)
- [RuoYi-Vue3-FastAPI Project](https://gitee.com/insistence2022/RuoYi-Vue3-FastAPI)
- [APScheduler Project](https://github.com/agronholm/apscheduler)
- [Vite Project](https://github.com/vitejs/vite)
- [UniApp Project](https://github.com/dcloudio/uni-app)
- [uView-plus Project](https://uiadmin.net/uview-plus)
---
## 🎨 Community
<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 Me
If you like this project, please give me a ⭐️ Star to show your support! Thank you very much!
---
## 👀 访问统计
![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=Thank you&fontSize=90&fontAlign=50&fontAlignY=78&desc=It's not too much to ask for a%20star ⭐️&descAlign=50&descSize=30&descAlignY=46&animation=twinkling" />
</p>
Reference in New Issue View Git Blame Copy Permalink