---
@@ -52,21 +30,21 @@ English | [Chinese](./README.md)
---
-## 📘 Project Introduction
+## 📘 Project Introduction (Author: @1014TaoTao)
-**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` to achieve unified multi-terminal development, providing an all-in-one, out-of-the-box development experience.
+**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.
-> **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.
+> **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.
```sh
fastapi_vue3_admin
├─ backend # Backend project
├─ frontend # Frontend project
├─ devops # Deployment project
-├─ docker-compose.yaml # Deployment configuration file
+├─ docker-compose.yaml # Deployment file
├─ start.sh # One-click deployment script
├─ LICENSE # License agreement
-├─ README.en.md # English documentation
+|─ README.en.md # English documentation
└─ README.md # Chinese documentation
```
@@ -75,76 +53,77 @@ fastapi_vue3_admin
## ✨ 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), and Vue3 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. |
-| 🚀 Easy Integration | Ready-to-use with mainstream frontend technology stacks such as Vue3, Vite5, Pinia, and Ant Design Vue |
+| ---- | ---- |
+| 🔭 Rapid Development | A completely open-source modern rapid development platform designed to help developers efficiently build high-quality mid- and back-end systems. |
+| 🌐 Full-stack Integration | Front-end and back-end separation, integrating Python (FastAPI) + Vue3 for multi-terminal development. |
+| 🧱 Modular Design | Highly decoupled system functions, facilitating easy expansion and maintenance. |
+| ⚡️ High-performance Asynchronous | Uses the FastAPI asynchronous framework + Redis cache to optimize API response speed. |
+| 🔒 Secure Authentication | Supports the JWT OAuth2 authentication mechanism to ensure system security. |
+| 📊 Permission Management | The RBAC model enables fine-grained permission control at the menu, button, and data levels. |
+| 🚀 Rapid Deployment | Supports one-click deployment with Docker/Docker Compose/Nginx. |
+| 📄 Developer-friendly | Provides comprehensive Chinese documentation, a Chinese interface, and a visual toolchain to reduce the learning curve. |
+| 🚀 Quick Access | Based on mainstream front-end technology stacks such as Vue3, Vite5, Pinia, and Ant Design Vue, it's ready to use out of the box. |
---
## 🛠️ 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 | Quickly build visually appealing UI components. |
-| 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. |
+| Type | Technology Selection | Description |
+|----------|---------------------------------|---------------------------------|
+| Backend Framework | FastAPI / Uvicorn / Pydantic 2.0 / Alembic | A modern, high-performance asynchronous framework with enforced type constraints and data migration capabilities. |
+| ORM | SQLAlchemy 2.0 | A powerful ORM library. |
+| Scheduled Tasks | APScheduler | Easily implement scheduled tasks. |
+| Authentication | PyJWT | Implement JWT authentication. |
+| Frontend Framework | Vue3 / Vite5 / Pinia / TypeScript | Quickly develop Vue3 applications. |
+| UI Library | Ant Design Vue | Quickly develop beautiful UI components. |
+| Database | MySQL / MongoDB | Powerful databases. |
+| Cache | Redis | A powerful caching database. |
+| Documentation | Swagger / Redoc | Automatically generate API documentation. |
+| Deployment | Docker / Nginx / Docker Compose | Quickly deploy projects. |
+
---
## 📌 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 |
+| Module Name | Sub-module Name | Description |
+|----------|---------------------|---------------------|
+| Dashboard | Workbench, Analysis Page | Entry for commonly used functions |
+| System Management | Includes sub-modules such as menu, department, position, role, user, log, configuration, announcement, dictionary, and task | Main system functions |
+| Monitoring Management | Online users, server monitoring, cache monitoring | System monitoring and management functions |
+| Public Management | Interface management, document management | Project interface documentation |
---
## 🍪 Demo Environment
-- **Demo URL**: 
-
-
-
- 
+ 
Task Management
API Management
Documentation Management
Personal Information
-
+ 
在线文档
字典管理
app登陆
app首页
app工作台
app个人中心
