From b3868ad3741dce21a5114524bf8effa18551beb8 Mon Sep 17 00:00:00 2001 From: admin Date: Tue, 9 Dec 2025 14:48:01 +0000 Subject: [PATCH] =?UTF-8?q?=E6=9B=B4=E6=96=B0=20README.zh.md?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.zh.md | 484 +++++++++++++++++++++++++-------------------------- 1 file changed, 239 insertions(+), 245 deletions(-) diff --git a/README.zh.md b/README.zh.md index e3e1048..445fb6a 100644 --- a/README.zh.md +++ b/README.zh.md @@ -1,245 +1,239 @@ -# Django-Vue3-Admin - -[![img](https://img.shields.io/badge/license-MIT-blue.svg)](https://gitee.com/liqianglog/django-vue-admin/blob/master/LICENSE) [![img](https://img.shields.io/badge/python-%3E=3.7.x-green.svg)](https://python.org/) [![PyPI - Django Version badge](https://img.shields.io/badge/django%20versions-3.2-blue)](https://docs.djangoproject.com/zh-hans/3.2/) [![img](https://img.shields.io/badge/node-%3E%3D%2012.0.0-brightgreen)](https://nodejs.org/zh-cn/) [![img](https://gitee.com/liqianglog/django-vue-admin/badge/star.svg?theme=dark)](https://gitee.com/liqianglog/django-vue-admin) - -[预 览](https://demo.dvadmin.com) | [官网文档](https://www.django-vue-admin.com) | [群聊](https://qm.qq.com/cgi-bin/qm/qr?k=fOdnHhC8DJlRHGYSnyhoB8P5rgogA6Vs&jump_from=webapi) | [社区](https://bbs.django-vue-admin.com) | [插件市场](https://bbs.django-vue-admin.com/plugMarket.html) | [Github](https://github.com/liqianglog/django-vue-admin) - - - -💡 **「关于」** - -我们是一群热爱代码的青年，在这个炙热的时代下，我们希望静下心来通过Code带来一点我们的色彩和颜色。 - -因为热爱，所以拥抱未来! - - -## 平台简介 - -💡 [django-vue3-admin](https://gitee.com/huge-dream/django-vue3-admin.git) 是一套全部开源的快速开发平台，毫无保留给个人免费使用、团体授权使用。 - django-vue3-admin 基于RBAC模型的权限控制的一整套基础开发平台，权限粒度达到列级别，前后端分离，后端采用django + django-rest-framework，前端采用基于 vue3 + CompositionAPI + typescript + vite + element plus - - - - -* 🧑‍🤝‍🧑前端采用 Vue3+TS+pinia+fastcrud(感谢[vue-next-admin](https://lyt-top.gitee.io/vue-next-admin-doc-preview/)) -* 👭后端采用 Python 语言 Django 框架以及强大的 [Django REST Framework](https://pypi.org/project/djangorestframework)。 -* 👫权限认证使用[Django REST Framework SimpleJWT](https://pypi.org/project/djangorestframework-simplejwt)，支持多终端认证系统。 -* 👬支持加载动态权限菜单，多方式轻松权限控制。 -* 👬全新的列权限管控，粒度细化到每一列。 -* 💏特别鸣谢：[vue-next-admin](https://lyt-top.gitee.io/vue-next-admin-doc-preview/)。 -* 💡特别感谢[jetbrains](https://www.jetbrains.com/) 为本开源项目提供免费的 IntelliJ IDEA 授权。 - -#### 🏭 环境支持 - -| Edge | Firefox | Chrome | Safari | -| --------- | ------------ | ----------- | ----------- | -| Edge ≥ 79 | Firefox ≥ 78 | Chrome ≥ 64 | Safari ≥ 12 | - -> 由于 Vue3 不再支持 IE11，故而 ElementPlus 也不支持 IE11 及之前版本。 - - - -## 在线体验 - -👩‍👧‍👦演示地址：[https://demo.dvadmin.com](https://demo.dvadmin.com) - -- 账号：superadmin - -- 密码：admin123456 - -👩‍👦‍👦文档地址：[DVAdmin官网](https://www.django-vue-admin.com) - - - -## 交流 - -- 交流社区：[戳我](https://bbs.django-vue-admin.com)👩‍👦‍👦 -- 插件市场：[戳我](https://bbs.django-vue-admin.com/plugMarket.html)👩‍👦‍👦 -- django-vue-admin交流01群(已满)：812482043 [点击链接加入群聊](https://qm.qq.com/cgi-bin/qm/qr?k=aJVwjDvH-Es4MPJQuoO32N0SucK22TE5&jump_from=webapi) -- django-vue-admin交流02群(已满)：687252418 [点击链接加入群聊](https://qm.qq.com/cgi-bin/qm/qr?k=4jJN4IjWGfxJ8YJXbb_gTsuWjR34WLdc&jump_from=webapi) -- django-vue-admin交流03群(已满)：442108213 [点击链接加入群聊](http://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=wsm5oSz3K8dElBYUDtLTcQSEPhINFkl8&authKey=M6sbER0z59ZakgBr5erFeZyFZU15CI52bErNZa%2FxSvvGIuVAbY0N5866v89hm%2FK4&noverify=0&group_code=442108213) -- django-vue-admin交流04群：442108213 [点击链接加入群聊](http://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=wsm5oSz3K8dElBYUDtLTcQSEPhINFkl8&authKey=M6sbER0z59ZakgBr5erFeZyFZU15CI52bErNZa%2FxSvvGIuVAbY0N5866v89hm%2FK4&noverify=0&group_code=442108213) - - - -## 给框架点赞 - -
- - -
- - -## 源码地址 - -gitee地址(主推)：[https://gitee.com/huge-dream/django-vue3-admin](https://gitee.com/huge-dream/django-vue3-admin)👩‍👦‍👦 - -github地址：[https://github.com/huge-dream/django-vue3-admin](https://github.com/huge-dream/django-vue3-admin)👩‍👦‍👦 - - -## 内置功能 - -1. 👨‍⚕️菜单管理：配置系统菜单，操作权限，按钮权限标识、后端接口权限等。 -2. 🧑‍⚕️部门管理：配置系统组织机构（公司、部门、角色）。 -3. 👩‍⚕️角色管理：角色菜单权限分配、数据权限分配、设置角色按部门进行数据范围权限划分。 -4. 🧑‍🎓按钮权限控制：授权角色的按钮权限和接口权限,可做到每一个接口都能授权数据范围。 -5. 🧑‍🎓字段列权限控制：授权页面的字段显示权限，具体到某一列的显示权限。 -7. 👨‍🎓用户管理：用户是系统操作者，该功能主要完成系统用户配置。 -8. 👬接口白名单：配置不需要进行权限校验的接口。 -9. 🧑‍🔧字典管理：对系统中经常使用的一些较为固定的数据进行维护。 -10. 🧑‍🔧地区管理：对省市县区域进行管理。 -11. 📁附件管理：对平台上所有文件、图片等进行统一管理。 -12. 🗓️操作日志：系统正常操作日志记录和查询；系统异常信息日志记录和查询。 -13. 🔌[插件市场 ](https://bbs.django-vue-admin.com/plugMarket.html)：基于Django-Vue-Admin框架开发的应用和插件。 - -## 插件市场 🔌 -1. #### [dvadmin3-folw 后台审批流插件](https://bbs.django-vue-admin.com/plugMarket/139.html) - -2. #### [dvadmin3 celery插件前端](https://bbs.django-vue-admin.com/plugMarket/134.html) - -3. #### [dvadmin3 celery插件后端](https://bbs.django-vue-admin.com/plugMarket/133.html) - -4. #### [dvadmin3-build插件](https://bbs.django-vue-admin.com/plugMarket/136.html) - -5. #### [dvadmin3-uniapp](https://e.coding.net/dvadmin-private/code/dvadmin3-uniapp-app.git) - -6. #### dvadmin3-folw-uniapp 审批(开发中，近期上线) - - - -## 仓库分支说明 💈 -主分支：master（稳定版本） -开发分支：develop - - -## 准备工作 -~~~ -Python >= 3.11.0 (最低3.9+版本) -nodejs >= 16.0 -Mysql >= 8.0 (可选，默认数据库sqlite3，支持5.7+，推荐8.0版本) -Redis (可选，最新版) -~~~ - -## 前端♝ - -```bash -# 克隆项目 -git clone https://gitee.com/huge-dream/django-vue3-admin.git - -# 进入项目目录 -cd web - -# 安装依赖 -npm install yarn -yarn install --registry=https://registry.npmmirror.com - -# 启动服务 -yarn build -# 浏览器访问 http://localhost:8080 -# .env.development 文件中可配置启动端口等参数 -# 构建生产环境 -# yarn run build -``` - - - -## 后端💈 - -~~~bash -1. 进入项目目录 cd backend -2. 在项目根目录中，复制 ./conf/env.example.py 文件为一份新的到 ./conf 文件夹下，并重命名为 env.py -3. 在 env.py 中配置数据库信息 - mysql数据库版本建议：8.0 - mysql数据库字符集：utf8mb4 -4. 安装依赖环境 - pip3 install -r requirements.txt -5. 执行迁移命令： - python3 manage.py makemigrations - python3 manage.py migrate -6. 初始化数据 - python3 manage.py init -7. 初始化省市县数据: - python3 manage.py init_area -8. 启动项目 - python3 manage.py runserver 0.0.0.0:8000 -或使用 uvicorn : - uvicorn application.asgi:application --port 8000 --host 0.0.0.0 --workers 8 -~~~ -## 开发建议 -前后端backend与web各自单独一个窗口打开进行开发 - -### 访问项目 - -- 访问地址：[http://localhost:8080](http://localhost:8080) (默认为此地址，如有修改请按照配置文件) -- 账号：`superadmin` 密码：`admin123456` - - - - - -### docker-compose 运行 - -~~~shell -# 先安装docker-compose (自行百度安装),执行此命令等待安装，如有使用celery插件请打开docker-compose.yml中celery 部分注释 -docker-compose up -d -# 初始化后端数据(第一次执行即可) -docker exec -ti dvadmin3-django bash -python manage.py makemigrations -python manage.py migrate -python manage.py init_area -python manage.py init -exit - -前端地址：http://127.0.0.1:8080 -后端地址：http://127.0.0.1:8080/api -# 在服务器上请把127.0.0.1 换成自己公网ip -账号：superadmin 密码：admin123456 - -# docker-compose 停止 -docker-compose down -# docker-compose 重启 -docker-compose restart -# docker-compose 启动时重新进行 build -docker-compose up -d --build -~~~ - - - -## 演示图✅ - -![image-01](https://foruda.gitee.com/images/1701348994587355489/1bc749e7_5074988.png) - -![image-02](https://foruda.gitee.com/images/1701349037811908960/80d361db_5074988.png) - -![image-03](https://foruda.gitee.com/images/1701349224478845203/954f0a7b_5074988.png) - -![image-04](https://foruda.gitee.com/images/1701349248928658877/64926724_5074988.png) - -![image-05](https://foruda.gitee.com/images/1701349259068943299/1306ba40_5074988.png) - -![image-06](https://foruda.gitee.com/images/1701349294894429495/e3b3a8cf_5074988.png) - -![image-07](https://foruda.gitee.com/images/1701350432536247561/3b26685e_5074988.png) - -![image-08](https://foruda.gitee.com/images/1701350455264771992/b364c57f_5074988.png) - -![image-09](https://foruda.gitee.com/images/1701350479266000753/e4e4f7c5_5074988.png) - -![image-10](https://foruda.gitee.com/images/1701350501421625746/f8dd215e_5074988.png) - -## 审批流插件 - -![输入链接说明](https://bbs.django-vue-admin.com/uploads/20250321/97fbbf29673edfd66a1edd49237791bb.png) - -![输入链接说明](https://bbs.django-vue-admin.com/uploads/20250321/c43aa51278cbc478287c718d22397479.png) - - -![输入链接说明](https://bbs.django-vue-admin.com/uploads/20250321/9732a5cca9c1166d1a65c35e313ab90d.png) - - -![输入链接说明](https://bbs.django-vue-admin.com/uploads/20250321/3ca9dd0801ce76d21435abcc8a3d505a.png) - -![输入链接说明](https://bbs.django-vue-admin.com/uploads/20250321/a87a8d2329ef66880af5b0f16c5ff823.png) - - - +# Django-Vue3-Admin + +[![img](https://img.shields.io/badge/license-MIT-blue.svg)](https://gitee.com/liqianglog/django-vue-admin/blob/master/LICENSE) [![img](https://img.shields.io/badge/python-%3E=3.7.x-green.svg)](https://python.org/) [![PyPI - Django Version badge](https://img.shields.io/badge/django%20versions-3.2-blue)](https://docs.djangoproject.com/zh-hans/3.2/) [![img](https://img.shields.io/badge/node-%3E%3D%2012.0.0-brightgreen)](https://nodejs.org/zh-cn/) [![img](https://gitee.com/liqianglog/django-vue-admin/badge/star.svg?theme=dark)](https://gitee.com/liqianglog/django-vue-admin) + +[预 览](https://demo.dvadmin.com) | [官网文档](https://www.django-vue-admin.com) | [群聊](https://qm.qq.com/cgi-bin/qm/qr?k=fOdnHhC8DJlRHGYSnyhoB8P5rgogA6Vs&jump_from=webapi) | [社区](https://bbs.django-vue-admin.com) | [插件市场](https://bbs.django-vue-admin.com/plugMarket.html) | [Github](https://github.com/liqianglog/django-vue-admin) + + + +💡 **「关于」** + +我们是一群热爱代码的青年，在这个炙热的时代下，我们希望静下心来通过Code带来一点我们的色彩和颜色。 + +因为热爱，所以拥抱未来! + + +## 平台简介 + +💡 [django-vue3-admin](https://gitee.com/huge-dream/django-vue3-admin.git) 是一套全部开源的快速开发平台，毫无保留给个人免费使用、团体授权使用。 + django-vue3-admin 基于RBAC模型的权限控制的一整套基础开发平台，权限粒度达到列级别，前后端分离，后端采用django + django-rest-framework，前端采用基于 vue3 + CompositionAPI + typescript + vite + element plus + + + + +* 🧑‍🤝‍🧑前端采用 Vue3+TS+pinia+fastcrud(感谢[vue-next-admin](https://lyt-top.gitee.io/vue-next-admin-doc-preview/)) +* 👭后端采用 Python 语言 Django 框架以及强大的 [Django REST Framework](https://pypi.org/project/djangorestframework)。 +* 👫权限认证使用[Django REST Framework SimpleJWT](https://pypi.org/project/djangorestframework-simplejwt)，支持多终端认证系统。 +* 👬支持加载动态权限菜单，多方式轻松权限控制。 +* 👬全新的列权限管控，粒度细化到每一列。 +* 💏特别鸣谢：[vue-next-admin](https://lyt-top.gitee.io/vue-next-admin-doc-preview/)。 +* 💡特别感谢[jetbrains](https://www.jetbrains.com/) 为本开源项目提供免费的 IntelliJ IDEA 授权。 + +#### 🏭 环境支持 + +| Edge | Firefox | Chrome | Safari | +| --------- | ------------ | ----------- | ----------- | +| Edge ≥ 79 | Firefox ≥ 78 | Chrome ≥ 64 | Safari ≥ 12 | + +> 由于 Vue3 不再支持 IE11，故而 ElementPlus 也不支持 IE11 及之前版本。 + + + +## 在线体验 + +👩‍👧‍👦演示地址：[https://demo.dvadmin.com](https://demo.dvadmin.com) + +- 账号：superadmin + +- 密码：admin123456 + +👩‍👦‍👦文档地址：[DVAdmin官网](https://www.django-vue-admin.com) + + + +## 交流 + +- 交流社区：[戳我](https://bbs.django-vue-admin.com)👩‍👦‍👦 +- 插件市场：[戳我](https://bbs.django-vue-admin.com/plugMarket.html)👩‍👦‍👦 +- django-vue-admin交流01群(已满)：812482043 [点击链接加入群聊](https://qm.qq.com/cgi-bin/qm/qr?k=aJVwjDvH-Es4MPJQuoO32N0SucK22TE5&jump_from=webapi) +- django-vue-admin交流02群(已满)：687252418 [点击链接加入群聊](https://qm.qq.com/cgi-bin/qm/qr?k=4jJN4IjWGfxJ8YJXbb_gTsuWjR34WLdc&jump_from=webapi) +- django-vue-admin交流03群(已满)：442108213 [点击链接加入群聊](http://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=wsm5oSz3K8dElBYUDtLTcQSEPhINFkl8&authKey=M6sbER0z59ZakgBr5erFeZyFZU15CI52bErNZa%2FxSvvGIuVAbY0N5866v89hm%2FK4&noverify=0&group_code=442108213) +- django-vue-admin交流04群：442108213 [点击链接加入群聊](http://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=wsm5oSz3K8dElBYUDtLTcQSEPhINFkl8&authKey=M6sbER0z59ZakgBr5erFeZyFZU15CI52bErNZa%2FxSvvGIuVAbY0N5866v89hm%2FK4&noverify=0&group_code=442108213) + + + + + +## 源码地址 + +gitee地址(主推)：[https://gitee.com/huge-dream/django-vue3-admin](https://gitee.com/huge-dream/django-vue3-admin)👩‍👦‍👦 + +github地址：[https://github.com/huge-dream/django-vue3-admin](https://github.com/huge-dream/django-vue3-admin)👩‍👦‍👦 + + +## 内置功能 + +1. 👨‍⚕️菜单管理：配置系统菜单，操作权限，按钮权限标识、后端接口权限等。 +2. 🧑‍⚕️部门管理：配置系统组织机构（公司、部门、角色）。 +3. 👩‍⚕️角色管理：角色菜单权限分配、数据权限分配、设置角色按部门进行数据范围权限划分。 +4. 🧑‍🎓按钮权限控制：授权角色的按钮权限和接口权限,可做到每一个接口都能授权数据范围。 +5. 🧑‍🎓字段列权限控制：授权页面的字段显示权限，具体到某一列的显示权限。 +7. 👨‍🎓用户管理：用户是系统操作者，该功能主要完成系统用户配置。 +8. 👬接口白名单：配置不需要进行权限校验的接口。 +9. 🧑‍🔧字典管理：对系统中经常使用的一些较为固定的数据进行维护。 +10. 🧑‍🔧地区管理：对省市县区域进行管理。 +11. 📁附件管理：对平台上所有文件、图片等进行统一管理。 +12. 🗓️操作日志：系统正常操作日志记录和查询；系统异常信息日志记录和查询。 +13. 🔌[插件市场 ](https://bbs.django-vue-admin.com/plugMarket.html)：基于Django-Vue-Admin框架开发的应用和插件。 + +## 插件市场 🔌 +1. #### [dvadmin3-folw 后台审批流插件](https://bbs.django-vue-admin.com/plugMarket/139.html) + +2. #### [dvadmin3 celery插件前端](https://bbs.django-vue-admin.com/plugMarket/134.html) + +3. #### [dvadmin3 celery插件后端](https://bbs.django-vue-admin.com/plugMarket/133.html) + +4. #### [dvadmin3-build插件](https://bbs.django-vue-admin.com/plugMarket/136.html) + +5. #### [dvadmin3-uniapp](https://e.coding.net/dvadmin-private/code/dvadmin3-uniapp-app.git) + +6. #### dvadmin3-folw-uniapp 审批(开发中，近期上线) + + + +## 仓库分支说明 💈 +主分支：master（稳定版本） +开发分支：develop + + +## 准备工作 +~~~ +Python >= 3.11.0 (最低3.9+版本) +nodejs >= 16.0 +Mysql >= 8.0 (可选，默认数据库sqlite3，支持5.7+，推荐8.0版本) +Redis (可选，最新版) +~~~ + +## 前端♝ + +```bash +# 克隆项目 +git clone https://gitee.com/huge-dream/django-vue3-admin.git + +# 进入项目目录 +cd web + +# 安装依赖 +npm install yarn +yarn install --registry=https://registry.npmmirror.com + +# 启动服务 +yarn build +# 浏览器访问 http://localhost:8080 +# .env.development 文件中可配置启动端口等参数 +# 构建生产环境 +# yarn run build +``` + + + +## 后端💈 + +~~~bash +1. 进入项目目录 cd backend +2. 在项目根目录中，复制 ./conf/env.example.py 文件为一份新的到 ./conf 文件夹下，并重命名为 env.py +3. 在 env.py 中配置数据库信息 + mysql数据库版本建议：8.0 + mysql数据库字符集：utf8mb4 +4. 安装依赖环境 + pip3 install -r requirements.txt +5. 执行迁移命令： + python3 manage.py makemigrations + python3 manage.py migrate +6. 初始化数据 + python3 manage.py init +7. 初始化省市县数据: + python3 manage.py init_area +8. 启动项目 + python3 manage.py runserver 0.0.0.0:8000 +或使用 uvicorn : + uvicorn application.asgi:application --port 8000 --host 0.0.0.0 --workers 8 +~~~ +## 开发建议 +前后端backend与web各自单独一个窗口打开进行开发 + +### 访问项目 + +- 访问地址：[http://localhost:8080](http://localhost:8080) (默认为此地址，如有修改请按照配置文件) +- 账号：`superadmin` 密码：`admin123456` + + + + + +### docker-compose 运行 + +~~~shell +# 先安装docker-compose (自行百度安装),执行此命令等待安装，如有使用celery插件请打开docker-compose.yml中celery 部分注释 +docker-compose up -d +# 初始化后端数据(第一次执行即可) +docker exec -ti dvadmin3-django bash +python manage.py makemigrations +python manage.py migrate +python manage.py init_area +python manage.py init +exit + +前端地址：http://127.0.0.1:8080 +后端地址：http://127.0.0.1:8080/api +# 在服务器上请把127.0.0.1 换成自己公网ip +账号：superadmin 密码：admin123456 + +# docker-compose 停止 +docker-compose down +# docker-compose 重启 +docker-compose restart +# docker-compose 启动时重新进行 build +docker-compose up -d --build +~~~ + + + +## 演示图✅ + +![image-01](https://foruda.gitee.com/images/1701348994587355489/1bc749e7_5074988.png) + +![image-02](https://foruda.gitee.com/images/1701349037811908960/80d361db_5074988.png) + +![image-03](https://foruda.gitee.com/images/1701349224478845203/954f0a7b_5074988.png) + +![image-04](https://foruda.gitee.com/images/1701349248928658877/64926724_5074988.png) + +![image-05](https://foruda.gitee.com/images/1701349259068943299/1306ba40_5074988.png) + +![image-06](https://foruda.gitee.com/images/1701349294894429495/e3b3a8cf_5074988.png) + +![image-07](https://foruda.gitee.com/images/1701350432536247561/3b26685e_5074988.png) + +![image-08](https://foruda.gitee.com/images/1701350455264771992/b364c57f_5074988.png) + +![image-09](https://foruda.gitee.com/images/1701350479266000753/e4e4f7c5_5074988.png) + +![image-10](https://foruda.gitee.com/images/1701350501421625746/f8dd215e_5074988.png) + +## 审批流插件 + +![输入链接说明](https://bbs.django-vue-admin.com/uploads/20250321/97fbbf29673edfd66a1edd49237791bb.png) + +![输入链接说明](https://bbs.django-vue-admin.com/uploads/20250321/c43aa51278cbc478287c718d22397479.png) + + +![输入链接说明](https://bbs.django-vue-admin.com/uploads/20250321/9732a5cca9c1166d1a65c35e313ab90d.png) + + +![输入链接说明](https://bbs.django-vue-admin.com/uploads/20250321/3ca9dd0801ce76d21435abcc8a3d505a.png) + +![输入链接说明](https://bbs.django-vue-admin.com/uploads/20250321/a87a8d2329ef66880af5b0f16c5ff823.png) + + +