diff --git a/README.en.md b/README.en.md index 83dda2e6..d5c0c732 100644 --- a/README.en.md +++ b/README.en.md @@ -1,50 +1,28 @@ -

- -

-

- -

-

- -

- -

- - Gitee Stars - - - GitHub Stars - - - License - - - - - - - - -

- -# 📊 GitHub Data Statistics (Author: @1014TaoTao) - - - - - - - -
- - - - - -
-

- Activity Graph -

+
+

+ +

+

Fastapi-Vue3-Admin v1.0.0

+

A modern, open-source, full-stack integrated rapid development platform for mid - and back - end systems. Give a ⭐️ to support!

+

+ + Gitee Stars + + + GitHub Stars + + + License + + + + + + + + +

+
--- @@ -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**: -- **Admin Account**: `admin` / Password: `123456` -- **Demo Account**: `demo` / Password: `123456` +- Demo URL: +- Administrator account: `admin` Password: `123456` +- Demo account: `demo` Password: `123456` --- ## 👷 Installation and Usage -### Version Details +### Version Information -| 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) | +| Type | Technology Stack | Version | +|----------|----------------------|---------------| +| Backend | Python | 3.10 (Versions greater than 3.10 may have compatibility issues. Upgrades will be considered in the future, but not for now.) | +| Backend | FastAPI | 0.109 | +| Frontend | Node.js | >= 20.0 (It is recommended to use the latest version.) | +| Frontend | npm | 16.14 | +| Frontend | Vue3 | 3.3 | +| Database | MySQL | 8.0 (It is recommended to use the latest version.) | +| Middleware | Redis | 7.0 (It is recommended to use the latest version.) | --- -### Getting the Code +### Get Code ```sh -# Clone Code to Local Machine +# Clone the code to your local machine git clone https://gitee.com/tao__tao/fastapi_vue3_admin.git -or +或 git clone https://github.com/1014TaoTao/fastapi_vue3_admin.git ``` @@ -153,22 +132,18 @@ git clone https://github.com/1014TaoTao/fastapi_vue3_admin.git ### Local Backend Startup ```sh -# Navigate to the backend project directory +# Enter 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 +python3 main.py run +or +python3 main.py run --env=dev +# Generate migration files +python3 main.py revision "Initial migration" --env=dev (default is dev if not specified) +# Apply migrations +python3 main.py upgrade --env=dev (default is dev if not specified) ``` --- @@ -176,66 +151,62 @@ python3 main.py upgrade --env=dev ### Local Frontend Startup ```sh -# 进入前端工程目录 +# Enter the frontend project directory cd frontend - -# 安装依赖 +# Install dependencies npm install - -# 启动前端服务 +# Start the frontend service npm run dev - -# 构建前端, 生成 `frontend/dist` 目录 +# Build the frontend and generate the `frontend/dist` directory npm run build ``` --- -### Local Access Addresses +### Local Access Address -- Frontend Address: -- API Address: -- Admin Account: `admin` Password: `123456` -- Demo Account: `demo` Password: `123456` +- Frontend address: +- API address: +- Administrator account: `admin` Password: `123456` +- Demo account: `demo` Password: `123456` --- -### Docker Deployment +### Docker Build ```sh -# Copy the script `fastapi_vue3_amdin/start.sh` to the server and grant execution permissions +# Copy the script `fastapi_vue3_admin/start.sh` to the server and grant execution permissions chmod +x start.sh - # Execute the script ./start.sh - # View images: docker images -a - # View containers: docker compose ps - # View logs -docker logs -f - +docker logs -f # Stop the service docker compose down - # Delete an image -docker rmi - +docker rmi # Delete a container -docker rm -``` +docker rm +# Backend configuration file directory +fastapi_vue3_admin/backend/env/.env.prod.py +# Frontend configuration file directory +fastapi_vue3_admin/frontend/vite.config.ts +and +fastapi_vue3_admin/frontend/.env.production +# Deployment file directory +fastapi_vue3_admin/docker-compose.yaml +and +fastapi_vue3_admin/devops/devops/nginx/nginx.conf -- **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 +## 🔧 Models @@ -259,7 +230,7 @@ docker rm - + @@ -270,7 +241,7 @@ docker rm --- -## 🙏 Special Thanks +## 🙏 Thanks Thanks to the contributions and support of the following projects, which have enabled the successful completion of this project: @@ -297,18 +268,14 @@ Thanks to the contributions and support of the following projects, which have en --- -## ❤️ Star Me +## ❤️ Star -If you like this project, please give me a ⭐️ Star to show your support! Thank you very much! +If you like this project, please give it a ⭐️ Star to show your support! Thank you very much! --- -## 👀 访问统计 +## 👀 Visitor Statistics ![Visitor Count](https://profile-counter.glitch.me/1014TaoTao/count.svg) --- - -

- -

diff --git a/README.md b/README.md index 268c6c90..895f2c7b 100644 --- a/README.md +++ b/README.md @@ -1,50 +1,28 @@ -

- -

-

- -

-

- -

- -

- - Gitee Stars - - - GitHub Stars - - - License - - - - - - - - -

- -# 📊 GitHub 数据统计（作者：@1014TaoTao） - -
Task Management API ManagementDocumentation ManagementDocument Management Personal Information
- - - - - -
- - - - - -
-

- Activity Graph -

+
+

+ +

+

Fastapi-Vue3-Admin v1.0.0

+

一套现代、开源、全栈融合的中后台快速开发平台，给个⭐️支持一下

+

+ + Gitee Stars + + + GitHub Stars + + + License + + + + + + + + +

+
--- @@ -52,7 +30,7 @@ --- -## 📘 项目介绍 +## 📘 项目介绍（作者：@1014TaoTao） **Fastapi-Vue3-Admin** 是一套 **完全开源、高度模块化、技术先进的现代化快速开发平台**，旨在帮助开发者高效搭建高质量的企业级中后台系统。该项目采用 **前后端分离架构**，融合 Python 后端框架 `FastAPI` 和前端主流框架 `Vue3` 实现多端统一开发，提供了一站式开箱即用的开发体验。 @@ -213,12 +191,18 @@ docsker compose down docker rmi <镜像名> # 删除容器 docker rm <容器名> -``` +# 后端配置文件目录 +fastapi_vue3_amdin/backend/env/.env.prod.py +# 前端配置文件目录 +fastapi_vue3_amdin/frontend/vite.config.ts +和 +fastapi_vue3_amdin/frontend/.env.production +# 部署文件目录 +fastapi_vue3_amdin/docker-compose.yaml +和 +fastapi_vue3_amdin/devops/devops/nginx/nginx.conf -- **部署问题排查**: - - 后端配置文件 `fastapi_vue3_amdin/backend/env/.env.prod.py` - - 前端配置文件 `fastapi_vue3_amdin/frontend/vite.config.ts` 和 `fastapi_vue3_amdin/frontend/.env.production` - - 部署文件 `fastapi_vue3_amdin/docker-compose.yaml` 和 `fastapi_vue3_amdin/devops/devops/nginx/nginx.conf` +``` --- @@ -295,7 +279,3 @@ docker rm <容器名> ![Visitor Count](https://profile-counter.glitch.me/1014TaoTao/count.svg) --- - -

- -

diff --git a/backend/docs/index.md b/backend/docs/index.md index c8c45a7e..2f40cdfa 100755 --- a/backend/docs/index.md +++ b/backend/docs/index.md @@ -1,56 +1,34 @@ -

- -

-

- -

-

- -

- -

- - Gitee Stars - - - GitHub Stars - - - License - - - - - - - - -

- -# 📊 GitHub 数据统计（作者：@1014TaoTao） - - - - - - - -
- - - - - -
-

- Activity Graph -

+
+

+ +

+

Fastapi-Vue3-Admin v1.0.0

+

一套现代、开源、全栈融合的中后台快速开发平台，给个⭐️支持一下

+

+ + Gitee Stars + + + GitHub Stars + + + License + + + + + + + + +

+
--- -## 📘 项目介绍 +## 📘 项目介绍（作者：@1014TaoTao） -**Fastapi-Vue3-Admin** 是一套 **完全开源、高度模块化、技术先进的现代化快速开发平台**，旨在帮助开发者高效搭建高质量的企业级中后台系统。该项目采用 **前后端分离架构**，融合 Python 后端框架 `FastAPI` 和前端主流框架 `Vue3`，实现多端统一开发，提供了一站式开箱即用的开发体验。 +**Fastapi-Vue3-Admin** 是一套 **完全开源、高度模块化、技术先进的现代化快速开发平台**，旨在帮助开发者高效搭建高质量的企业级中后台系统。该项目采用 **前后端分离架构**，融合 Python 后端框架 `FastAPI` 和前端主流框架 `Vue3` 实现多端统一开发，提供了一站式开箱即用的开发体验。 > **设计初心**: 以模块化、松耦合为核心，追求丰富的功能模块、简洁易用的接口、详尽的开发文档和便捷的维护方式。通过统一框架和组件，降低技术选型成本，遵循开发规范和设计模式，构建强大的代码分层模型，搭配完善的本地中文化支持，专为团队和企业开发场景量身定制。 @@ -73,7 +51,7 @@ fastapi_vue3_admin | 特性 | 描述 | | ---- | ---- | | 🔭 快速开发 |一套完全开源的现代化快速开发平台，旨在帮助开发者高效搭建高质量的中后台系统。| -| 🌐 全栈整合 | 前后端分离，融合 Python (FastAPI) + Vue3 | +| 🌐 全栈整合 | 前后端分离，融合 Python (FastAPI) + Vue3 多端开发 | | 🧱 模块化设计 | 系统功能高度解耦，便于扩展和维护 | | ⚡️ 高性能异步 | 使用 FastAPI 异步框架 + Redis 缓存优化接口响应速度 | | 🔒 安全认证 | 支持 JWT OAuth2 认证机制，保障系统安全 | @@ -93,7 +71,7 @@ fastapi_vue3_admin | 定时任务 | APScheduler | 轻松实现定时任务。 | | 权限认证 | PyJWT | 实现 JWT 认证。 | | 前端框架 | Vue3 / Vite5 / Pinia / TypeScript | 快速开发 Vue3 应用。 | -| UI 库 | Ant Design Vue | 快速开发美观的 UI 组件。 | +| UI 库 | Ant Design Vue | 快速开发美观的 UI 组件。 | | 数据库 | MySQL / MongoDB | 强大的数据库。 | | 缓存 | Redis | 强大的缓存数据库。 | | 文档 | Swagger / Redoc | 自动生成 API 文档。 | @@ -109,7 +87,6 @@ fastapi_vue3_admin | 系统管理 | 包含菜单、部门、岗位、角色、用户、日志、配置、公告、字典、任务等子模块|系统主功能 | | 监控管理 | 在线用户、服务器监控、缓存监控 |系统监控管理功能 | | 公共管理 | 接口管理、文档管理|项目接口文档 | -| App 端 | 首页、工作台、个人中心|移动端应用管理 | --- @@ -185,7 +162,6 @@ npm run build ### 本地访问地址 - 前端地址: -- 小程序地址: - 接口地址: - 管理员账号：`admin` 密码：`123456` - 演示账号：`demo` 密码：`123456` @@ -198,11 +174,7 @@ npm run build # 复制脚本 `fastapi_vue3_amdin/start.sh` 脚本文件到服务器, 并赋予执行权限 chmod +x start.sh # 执行脚本 -https://gitee.com/tao__tao/fastapi_vue3_admin/raw/master/backend/docs/start.sh -# 访问地址 -# 前端访问: `http://公网地址:80`, -# 接口访问: `http://公网地址:8001/api/v1/docs`， -# 登录 `admin/123456` 或 `demo/123456` +./start.sh # 查看镜像: docsker images -a # 查看容器: @@ -215,12 +187,18 @@ docsker compose down docker rmi <镜像名> # 删除容器 docker rm <容器名> -``` +# 后端配置文件目录 +fastapi_vue3_amdin/backend/env/.env.prod.py +# 前端配置文件目录 +fastapi_vue3_amdin/frontend/vite.config.ts +和 +fastapi_vue3_amdin/frontend/.env.production +# 部署文件目录 +fastapi_vue3_amdin/docker-compose.yaml +和 +fastapi_vue3_amdin/devops/devops/nginx/nginx.conf -- **部署问题排查**: - - 后端配置文件 `fastapi_vue3_amdin/backend/env/.env.prod.py` - - 前端配置文件 `fastapi_vue3_amdin/frontend/vite.config.ts` 和 `fastapi_vue3_amdin/frontend/.env.production` - - 部署文件 `fastapi_vue3_amdin/docker-compose.yaml` 和 `fastapi_vue3_amdin/devops/devops/nginx/nginx.conf` +``` --- @@ -255,12 +233,6 @@ docker rm <容器名> 在线文档 字典管理 - - app登陆 - app首页 - app工作台 - app个人中心 - --- @@ -282,13 +254,15 @@ docker rm <容器名> ## 🎨 社区 + - - - + + +
+ --- ## ❤️ Star 支持我 @@ -302,7 +276,3 @@ docker rm <容器名> ![Visitor Count](https://profile-counter.glitch.me/1014TaoTao/count.svg) --- - -

- -

diff --git a/backend/docs/resources/header.gif b/backend/docs/resources/header.gif deleted file mode 100644 index f0f925ad..00000000 Binary files a/backend/docs/resources/header.gif and /dev/null differ diff --git a/backend/docs/resources/logo.png b/backend/docs/resources/logo.png new file mode 100644 index 00000000..c3e72ce0 Binary files /dev/null and b/backend/docs/resources/logo.png differ diff --git a/frontend/public/site/index.html b/frontend/public/site/index.html index a3db5c76..b74bf8b6 100644 --- a/frontend/public/site/index.html +++ b/frontend/public/site/index.html @@ -62,7 +62,7 @@
- + 跳转至 @@ -255,8 +255,6 @@ - -