From b40b7219bc120bf6e76a93029908e60e6100c592 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=9D=8E=E5=BC=BA?= <1206709430@qq.com> Date: Tue, 6 Jun 2023 09:21:03 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E2=9A=A1=20=E4=B8=AD=E8=8B=B1=E6=96=87?= =?UTF-8?q?=E6=96=87=E6=A1=A3=E6=9B=BF=E6=8D=A2?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.en.md | 227 -------------------------------------------- README.md | 261 ++++++++++++++++++++++++--------------------------- README.zh.md | 238 ++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 363 insertions(+), 363 deletions(-) delete mode 100644 README.en.md create mode 100644 README.zh.md diff --git a/README.en.md b/README.en.md deleted file mode 100644 index 7858826..0000000 --- a/README.en.md +++ /dev/null @@ -1,227 +0,0 @@ -# Django-Vue-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) - -[中文文档](./README.md) | [preview](https://demo.django-vue-admin.com) | [Official website document](https://www.django-vue-admin.com) | [qq group](https://qm.qq.com/cgi-bin/qm/qr?k=fOdnHhC8DJlRHGYSnyhoB8P5rgogA6Vs&jump_from=webapi) | [community](https://bbs.django-vue-admin.com) | [plugins market](https://bbs.django-vue-admin.com/plugMarket.html) | [Github](https://github.com/liqianglog/django-vue-admin) - -💡 **「About」** - -We are a group of young people who love Code. In this hot era, we hope to calm down and bring some of our colors and colors through code. - -Because of love, so embrace the future - - - -🗓️ **「Development Roadmap」** - -Please leave your valuable suggestions for creating a more comprehensive dvadmin [Submit Requirements](https://rgej2wr12o.feishu.cn/share/base/form/shrcnsHNfeC9URj6RIOR3xPPD3f) | [Roadmap](https://rgej2wr12o.feishu.cn/base/KevWbAzaEazgD2s8SmKc36PJnwb) - - - -👩‍👦‍👦 **「Essay Competition」** - -To promote better community development, we are organizing the dvadmin Essay Competition. Exciting prizes, including **perpetual commercial licenses**, await you. [Click here to view the details](https://bbs.django-vue-admin.com/question/462.html). - - - - -## framework introduction - -💡 [django-vue-admin](https://gitee.com/dvadmin/django-vue-admin) Is a set of all open source rapid development platform, no reservation for individuals and enterprises free use. - -* 🧑‍🤝‍🧑Front-end adoption[D2Admin](https://github.com/d2-projects/d2-admin) 、[Vue](https://cn.vuejs.org/)、[ElementUI](https://element.eleme.cn/)。 -* 👭The backend uses the Python language Django framework as well as the powerful[Django REST Framework](https://pypi.org/project/djangorestframework)。 -* 👫Permission authentication use[Django REST Framework SimpleJWT](https://pypi.org/project/djangorestframework-simplejwt),Supports the multi-terminal authentication system. -* 👬Support loading dynamic permission menu, multi - way easy permission control. -* 💏 Special thanks:[D2Admin](https://github.com/d2-projects/d2-admin) 、[Vue-Element-Admin](https://github.com/PanJiaChen/vue-element-admin)。 -* 💡 Special thanks:[jetbrains](https://www.jetbrains.com/) To provide a free IntelliJ IDEA license for this open source project. - - - -## Online experience - -👩‍👧‍👦demo address:[http://demo.django-vue-admin.com](http://demo.django-vue-admin.com) - -* demo account:superadmin - -* demo password:admin123456 - -👩‍👦‍👦docs:[https://django-vue-admin.com](https://django-vue-admin.com) - - - -## Communication - -- Communication community:[click here](https://bbs.django-vue-admin.com)👩‍👦‍👦 - -- plugins market:[click here](https://bbs.django-vue-admin.com/plugMarket.html)👩‍👦‍👦 - -- django-vue-admin Discussion Group 01 (Full): 812482043 [Click here to join the group chat](https://qm.qq.com/cgi-bin/qm/qr?k=aJVwjDvH-Es4MPJQuoO32N0SucK22TE5&jump_from=webapi) - -- django-vue-admin Discussion Group 02 (Full): 687252418 [Click here to join the group chat](https://qm.qq.com/cgi-bin/qm/qr?k=4jJN4IjWGfxJ8YJXbb_gTsuWjR34WLdc&jump_from=webapi) - -- django-vue-admin Discussion Group 03 : 442108213 [Click here to join the group chat](https://qm.qq.com/cgi-bin/qm/qr?k=ESpuF6A1Fcx0XrY4w6CzCvbnjI4kNsa0&jump_from=webapi) - -- QR Code Image - - - - - -## core function - -1. 👨‍⚕️ Menu management: Configure the system menu, operation permissions, button permissions, back-end interface permissions, etc. -2. 🧑‍⚕️ Department management: Configure the system organization (company, department, role). -3. 👩‍⚕️ Role management: role menu permission allocation, data permission allocation, set roles according to the department for data range permission division. -4. 🧑‍🎓 Rights Specifies the rights of the authorization role. -5. 👨‍🎓 User management: The user is the system operator, this function mainly completes the system user configuration. -6. 👬 Interface whitelist: specifies the interface that does not need permission verification. -7. 🧑‍🔧 Dictionary management: Maintenance of some fixed data frequently used in the system. -8. 🧑‍🔧 Regional management: to manage provinces, cities, counties and regions. -9. 📁 Attachment management: Unified management of all files and pictures on the platform. -10. 🗓 ️operation logs: log and query the system normal operation; Log and query system exception information. -11. 🔌 [plugins market](https://bbs.django-vue-admin.com/plugMarket.html) : based on the Django framework - Vue - Admin application and plug-in development. - -## source code url: - -gitee(Main push):[https://gitee.com/liqianglog/django-vue-admin](https://gitee.com/liqianglog/django-vue-admin)👩‍👦‍👦 - -github:[https://github.com/liqianglog/django-vue-admin](https://github.com/liqianglog/django-vue-admin)👩‍👦‍👦 - -| Project | Star | Introduction | -| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | -| [django-vue-admin](https://gitee.com/liqianglog/django-vue-admin) | [![Gitee star](https://gitee.com/liqianglog/django-vue-admin/badge/star.svg?theme=white)](https://gitee.com/liqianglog/django-vue-admin) [![GitHub stars](https://img.shields.io/github/stars/liqianglog/django-vue-admin.svg?style=social&label=Stars)](https://github.com/liqianglog/django-vue-admin) | Management Dashboard based on
Vue2 + Element + D2Admin + Django. | -| [django-vue3-admin](https://gitee.com/huge-dream/django-vue3-admin) | [![Gitee star](https://gitee.com/huge-dream/django-vue3-admin/badge/star.svg?theme=white)](https://gitee.com/huge-dream/django-vue3-admin) [![GitHub stars](https://img.shields.io/github/stars/huge-dream/django-vue3-admin.svg?style=social&label=Stars)](https://github.com/huge-dream/django-vue3-admin) | Management Dashboard implemented based on
Vue3 + vue-next-admin + fastcrud + Django. | - -## plugins market 🔌 - -#### [Click here to view the latest development progress](https://rgej2wr12o.feishu.cn/base/KevWbAzaEazgD2s8SmKc36PJnwb?table=tblpongo56gp6zN9&view=vewpLA5Hdc) | [Plugin Market](https://bbs.django-vue-admin.com/plugMarket.html) - -| Plugin Name | Development Status | Description | -| ------------------------------------------------------------ | ------------------ | ------------------------------------------------------------ | -| [dvadmin3-celery 定时任务](https://bbs.django-vue-admin.com/plugMarket/129.html) | Released | Enables asynchronous tasks in dvadmin3, including task scheduling and record management | -| [dvadmin-celery 定时任务](https://bbs.django-vue-admin.com/plugMarket/115.html) | Released | Enables asynchronous tasks in dvadmin3, including task scheduling and record management | -| [dvadmin-sms 短信服务](https://bbs.django-vue-admin.com/plugMarket/128.html) | Released | Integrates SMS service plugins for various platforms | -| [dvadmin-vform 表单设计器](https://bbs.django-vue-admin.com/plugMarket/118.html) | Released | Low-code form designer plugin | -| [dvadmin-tenants 多租户管理](https://bbs.django-vue-admin.com/plugMarket/124.html) | Released | Saas mode for multi-tenancy management | -| [dvadmin-third 第三方用户管理](https://bbs.django-vue-admin.com/plugMarket/122.html) | Released | Plugin for managing third-party users | -| [dvadmin-ak-sk 加密密钥管理](https://bbs.django-vue-admin.com/plugMarket/120.html) | Released | Manages encryption keys for verifying authentication strings | -| [dvadmin-pay 支付插件](https://bbs.django-vue-admin.com/plugMarket/131.html) | Released | Payment plugin for dvadmin, supports WeChat Pay and Alipay | -| [dvadmin-uniapp](https://bbs.django-vue-admin.com/plugMarket/130.html) | Released | Uniapp plugin for dvadmin | -| dvadmin-cloud-storage 云存储插件 | Development | Plugin for storing files using various cloud storage providers | -| dvadmin-es 搜索插件 | Development | Search plugin for Elasticsearch | -| dvadmin-low-code-crud 低代码生成 | Development | Low-code generation plugin | -| dvadmin-flow 工作流插件 | Development | Workflow plugin | - -## before start project you need: - -~~~ -Python >= 3.8.0 -nodejs >= 14.0 -Mysql >= 5.7.0 (Optional. The default database is sqlite3. 8.0 is recommended) -Redis(Optional, the latest edition) -~~~ - -## frontend♝ - -```bash -# clone code -git clone https://gitee.com/liqianglog/django-vue-admin.git - -# enter code dir -cd web - -# install dependence -npm install --registry=https://registry.npm.taobao.org - -# Start service -npm run dev -# Visit http://localhost:8080 in your browser -# Parameters such as boot port can be configured in the #.env.development file -# Build the production environment -# npm run build -``` - -## backend💈 - -~~~bash -1. enter code dir cd backend -2. copy ./conf/env.example.py to ./conf dir,rename as env.py -3. in env.py configure database information - mysql database recommended version: 8.0 - mysql database character set: utf8mb4 -4. install pip dependence - pip3 install -r requirements.txt -5. Execute the migration command: - python3 manage.py makemigrations - python3 manage.py migrate -6. Initialization data - python3 manage.py init -7. Initialize provincial, municipal and county data: - python3 manage.py init_area -8. start backend - python3 manage.py runserver 0.0.0.0:8000 -or gunicorn : - gunicorn -c gunicorn_conf.py application.asgi:application -~~~ - -### visit backend swagger - -* visit url:[http://localhost:8080](http://localhost:8080) (The default address is this one. If you want to change it, follow the configuration file) -* account:`superadmin` password:`admin123456` - -### docker-compose - -~~~shell -docker-compose up -d -# Initialize backend data (first execution only) -docker exec -ti dvadmin-django bash -python manage.py makemigrations -python manage.py migrate -python manage.py init_area -python manage.py init -exit - -frontend url:http://127.0.0.1:8080 -backend url:http://127.0.0.1:8080/api -# Change 127.0.0.1 to your own public ip address on the server -account:`superadmin` password:`admin123456` - -# docker-compose stop -docker-compose down -# docker-compose restart -docker-compose restart -# docker-compose on start build -docker-compose up -d --build -~~~ - -## Demo screenshot✅ - -![image-01](https://foruda.gitee.com/images/1682179942561449504/020863bb_5074988.jpeg) - -![image-02](https://foruda.gitee.com/images/1682179701820334814/f20eb5e8_5074988.png) - -![image-03](https://foruda.gitee.com/images/1682179718209143602/e6b6a4b1_5074988.png) - -![image-04](https://foruda.gitee.com/images/1681118349561624452/d917f8bc_5074988.jpeg) - -![image-05](https://foruda.gitee.com/images/1681118368415555513/03a8db63_5074988.jpeg) - -![image-06](https://foruda.gitee.com/images/1681118379484890540/6f9caa75_5074988.jpeg) - -![image-07](https://foruda.gitee.com/images/1681118387902110958/86d86d80_5074988.jpeg) - -![image-08](https://foruda.gitee.com/images/1681118398381431700/1e3fa0ec_5074988.jpeg) - -![image-09](https://foruda.gitee.com/images/1681118450796081811/aa00a240_5074988.png) - -![image-10](https://foruda.gitee.com/images/1681118482618114892/5cc2e297_5074988.png) - -![image-11](https://foruda.gitee.com/images/1681118492497719384/52a47252_5074988.png) - -![image-12](https://foruda.gitee.com/images/1681118517168485285/f34152ba_5074988.png) - -## Commercial License - -![image-13](https://foruda.gitee.com/images/1681118527820910716/43a7c660_5074988.png) - diff --git a/README.md b/README.md index 1f51719..b9a49b5 100644 --- a/README.md +++ b/README.md @@ -2,187 +2,179 @@ [![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) -[English](./README.en.md) | [预 览](https://demo.django-vue-admin.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) +[中文文档](./README.zh.md) | [preview](https://demo.django-vue-admin.com) | [Official website document](https://www.django-vue-admin.com) | [qq group](https://qm.qq.com/cgi-bin/qm/qr?k=fOdnHhC8DJlRHGYSnyhoB8P5rgogA6Vs&jump_from=webapi) | [community](https://bbs.django-vue-admin.com) | [plugins market](https://bbs.django-vue-admin.com/plugMarket.html) | [Github](https://github.com/liqianglog/django-vue-admin) + +💡 **「About」** + +We are a group of young people who love Code. In this hot era, we hope to calm down and bring some of our colors and colors through code. + +Because of love, so embrace the future -💡 **「关于」** +🗓️ **「Development Roadmap」** -我们是一群热爱代码的青年,在这个炙热的时代下,我们希望静下心来通过Code带来一点我们的色彩和颜色。 - -因为热爱,所以拥抱未来 +Please leave your valuable suggestions for creating a more comprehensive dvadmin [Submit Requirements](https://rgej2wr12o.feishu.cn/share/base/form/shrcnsHNfeC9URj6RIOR3xPPD3f) | [Roadmap](https://rgej2wr12o.feishu.cn/base/KevWbAzaEazgD2s8SmKc36PJnwb) -🗓️ **「开发线路」** +👩‍👦‍👦 **「Essay Competition」** -请留下您宝贵建议,打造更加完善的dvadmin [需求提交](https://rgej2wr12o.feishu.cn/share/base/form/shrcnsHNfeC9URj6RIOR3xPPD3f) | [需求线路图](https://rgej2wr12o.feishu.cn/base/KevWbAzaEazgD2s8SmKc36PJnwb) +To promote better community development, we are organizing the dvadmin Essay Competition. Exciting prizes, including **perpetual commercial licenses**, await you. [Click here to view the details](https://bbs.django-vue-admin.com/question/462.html). -👩‍👦‍👦 **「征文大赛」** -为促进社区的更好发展,现开展dvadmin征文大赛,更有 **永久商业授权** 等丰厚奖品等你来拿 [点我查看详情](https://bbs.django-vue-admin.com/question/462.html) +## framework introduction + +💡 [django-vue-admin](https://gitee.com/dvadmin/django-vue-admin) Is a set of all open source rapid development platform, no reservation for individuals and enterprises free use. + +* 🧑‍🤝‍🧑Front-end adoption[D2Admin](https://github.com/d2-projects/d2-admin) 、[Vue](https://cn.vuejs.org/)、[ElementUI](https://element.eleme.cn/)。 +* 👭The backend uses the Python language Django framework as well as the powerful[Django REST Framework](https://pypi.org/project/djangorestframework)。 +* 👫Permission authentication use[Django REST Framework SimpleJWT](https://pypi.org/project/djangorestframework-simplejwt),Supports the multi-terminal authentication system. +* 👬Support loading dynamic permission menu, multi - way easy permission control. +* 💏 Special thanks:[D2Admin](https://github.com/d2-projects/d2-admin) 、[Vue-Element-Admin](https://github.com/PanJiaChen/vue-element-admin)。 +* 💡 Special thanks:[jetbrains](https://www.jetbrains.com/) To provide a free IntelliJ IDEA license for this open source project. -## 平台简介 +## Online experience -💡 [django-vue-admin](https://gitee.com/dvadmin/django-vue-admin) 是一套全部开源的快速开发平台,毫无保留给个人及企业免费使用。 +👩‍👧‍👦demo address:[http://demo.django-vue-admin.com](http://demo.django-vue-admin.com) + +* demo account:superadmin + +* demo password:admin123456 + +👩‍👦‍👦docs:[https://django-vue-admin.com](https://django-vue-admin.com) -* 🧑‍🤝‍🧑前端采用[D2Admin](https://github.com/d2-projects/d2-admin) 、[Vue](https://cn.vuejs.org/)、[ElementUI](https://element.eleme.cn/)。 -* 👭后端采用 Python 语言 Django 框架以及强大的 [Django REST Framework](https://pypi.org/project/djangorestframework)。 -* 👫权限认证使用[Django REST Framework SimpleJWT](https://pypi.org/project/djangorestframework-simplejwt),支持多终端认证系统。 -* 👬支持加载动态权限菜单,多方式轻松权限控制。 -* 💏特别鸣谢:[D2Admin](https://github.com/d2-projects/d2-admin) 、[Vue-Element-Admin](https://github.com/PanJiaChen/vue-element-admin)。 -* 💡 特别感谢[jetbrains](https://www.jetbrains.com/) 为本开源项目提供免费的 IntelliJ IDEA 授权。 +## Communication +- Communication community:[click here](https://bbs.django-vue-admin.com)👩‍👦‍👦 +- plugins market:[click here](https://bbs.django-vue-admin.com/plugMarket.html)👩‍👦‍👦 -## 在线体验 +- django-vue-admin Discussion Group 01 (Full): 812482043 [Click here to join the group chat](https://qm.qq.com/cgi-bin/qm/qr?k=aJVwjDvH-Es4MPJQuoO32N0SucK22TE5&jump_from=webapi) -👩‍👧‍👦演示地址:[http://demo.django-vue-admin.com](http://demo.django-vue-admin.com) +- django-vue-admin Discussion Group 02 (Full): 687252418 [Click here to join the group chat](https://qm.qq.com/cgi-bin/qm/qr?k=4jJN4IjWGfxJ8YJXbb_gTsuWjR34WLdc&jump_from=webapi) -- 账号:superadmin +- django-vue-admin Discussion Group 03 : 442108213 [Click here to join the group chat](https://qm.qq.com/cgi-bin/qm/qr?k=ESpuF6A1Fcx0XrY4w6CzCvbnjI4kNsa0&jump_from=webapi) -- 密码:admin123456 - -👩‍👦‍👦文档地址:[https://django-vue-admin.com](https://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 [点击链接加入群聊](https://qm.qq.com/cgi-bin/qm/qr?k=ESpuF6A1Fcx0XrY4w6CzCvbnjI4kNsa0&jump_from=webapi) - -- 二维码 +- QR Code Image -## 内置功能 - -1. 👨‍⚕️菜单管理:配置系统菜单,操作权限,按钮权限标识、后端接口权限等。 -2. 🧑‍⚕️部门管理:配置系统组织机构(公司、部门、角色)。 -3. 👩‍⚕️角色管理:角色菜单权限分配、数据权限分配、设置角色按部门进行数据范围权限划分。 -4. 🧑‍🎓权限权限:授权角色的权限范围。 -5. 👨‍🎓用户管理:用户是系统操作者,该功能主要完成系统用户配置。 -6. 👬接口白名单:配置不需要进行权限校验的接口。 -7. 🧑‍🔧字典管理:对系统中经常使用的一些较为固定的数据进行维护。 -8. 🧑‍🔧地区管理:对省市县区域进行管理。 -9. 📁附件管理:对平台上所有文件、图片等进行统一管理。 -10. 🗓️操作日志:系统正常操作日志记录和查询;系统异常信息日志记录和查询。 -11. 🔌[插件市场 ](https://bbs.django-vue-admin.com/plugMarket.html):基于Django-Vue-Admin框架开发的应用和插件。 - -## 源码地址 - -gitee地址(主推):[https://gitee.com/liqianglog/django-vue-admin](https://gitee.com/liqianglog/django-vue-admin)👩‍👦‍👦 - -github地址:[https://github.com/liqianglog/django-vue-admin](https://github.com/liqianglog/django-vue-admin)👩‍👦‍👦 - -| 项目 | Star | 简介 | -| ------------------------------------------------------------ | ------------------------------------------------------------ | -------------------------------------------- | -| [django-vue-admin](https://gitee.com/liqianglog/django-vue-admin) | [![Gitee star](https://gitee.com/liqianglog/django-vue-admin/badge/star.svg?theme=white)](https://gitee.com/liqianglog/django-vue-admin) [![GitHub stars](https://img.shields.io/github/stars/liqianglog/django-vue-admin.svg?style=social&label=Stars)](https://github.com/liqianglog/django-vue-admin) | 基于 Vue2 + element + d2admin + django 实现的管理后台 | -| [django-vue3-admin](https://gitee.com/huge-dream/django-vue3-admin) | [![Gitee star](https://gitee.com/huge-dream/django-vue3-admin/badge/star.svg?theme=white)](https://gitee.com/huge-dream/django-vue3-admin) [![GitHub stars](https://img.shields.io/github/stars/huge-dream/django-vue3-admin.svg?style=social&label=Stars)](https://github.com/huge-dream/django-vue3-admin) | 基于 Vue3 + vue-next-admin + fastcrud + django 实现的管理后台 | - -## 插件市场 🔌 - -#### [点我查看最新开发进度](https://rgej2wr12o.feishu.cn/base/KevWbAzaEazgD2s8SmKc36PJnwb?table=tblpongo56gp6zN9&view=vewpLA5Hdc) | [插件市场](https://bbs.django-vue-admin.com/plugMarket.html) - -| 插件名称 | 开发状态 | 简介 | -| --------------------------------------------------------- | -------- | ------------------------------------------------------------ | -| [dvadmin3-celery 定时任务](https://bbs.django-vue-admin.com/plugMarket/129.html) | 已发布 | 适用dvadmin3可快速使用异步任务,包含在线添加任务、任务记录等 | -| [dvadmin-celery 定时任务](https://bbs.django-vue-admin.com/plugMarket/115.html) | 已发布 | 适用dvadmin3可快速使用异步任务,包含在线添加任务、任务记录等 | -| [dvadmin-sms 短信服务](https://bbs.django-vue-admin.com/plugMarket/128.html) | 已发布 | 整合各端的短信服务插件 | -| [dvadmin-vform 表单设计器](https://bbs.django-vue-admin.com/plugMarket/118.html) | 已发布 | 低代码表单设计器插件 | -| [dvadmin-tenants 多租户管理](https://bbs.django-vue-admin.com/plugMarket/124.html) | 已发布 | 多租户的saas模式 | -| [dvadmin-third 第三方用户管理](https://bbs.django-vue-admin.com/plugMarket/122.html) | 已发布 | 第三方用户管理插件 | -| [dvadmin-ak-sk 加密密钥管理](https://bbs.django-vue-admin.com/plugMarket/120.html) | 已发布 | 用于加密认证字符串来验证认证字符串的密钥 | -| [dvadmin-pay 支付插件](https://bbs.django-vue-admin.com/plugMarket/131.html) | 已发布 | 适用于dvadmin的支付插件,支持微信支持、支付宝支付 | -| [dvadmin-uniapp](https://bbs.django-vue-admin.com/plugMarket/130.html) | 已发布 | 适用于dvadmin的uniapp插件 | -| dvadmin-cloud-storage 云存储插件 | 开发中 | 适用各种云存储进行存储插件 | -| dvadmin-es 搜索插件 | 开发中 | 适用于es的搜索插件 | -| dvadmin-low-code-crud 低代码生成 | 开发中 | 低代码生成插件 | -| dvadmin-flow 工作流插件 | 开发中 | 工作流插件 | +## core function -## 准备工作 +1. 👨‍⚕️ Menu management: Configure the system menu, operation permissions, button permissions, back-end interface permissions, etc. +2. 🧑‍⚕️ Department management: Configure the system organization (company, department, role). +3. 👩‍⚕️ Role management: role menu permission allocation, data permission allocation, set roles according to the department for data range permission division. +4. 🧑‍🎓 Rights Specifies the rights of the authorization role. +5. 👨‍🎓 User management: The user is the system operator, this function mainly completes the system user configuration. +6. 👬 Interface whitelist: specifies the interface that does not need permission verification. +7. 🧑‍🔧 Dictionary management: Maintenance of some fixed data frequently used in the system. +8. 🧑‍🔧 Regional management: to manage provinces, cities, counties and regions. +9. 📁 Attachment management: Unified management of all files and pictures on the platform. +10. 🗓 ️operation logs: log and query the system normal operation; Log and query system exception information. +11. 🔌 [plugins market](https://bbs.django-vue-admin.com/plugMarket.html) : based on the Django framework - Vue - Admin application and plug-in development. + +## source code url: + +gitee(Main push):[https://gitee.com/liqianglog/django-vue-admin](https://gitee.com/liqianglog/django-vue-admin)👩‍👦‍👦 + +github:[https://github.com/liqianglog/django-vue-admin](https://github.com/liqianglog/django-vue-admin)👩‍👦‍👦 + +| Project | Star | Introduction | +| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | +| [django-vue-admin](https://gitee.com/liqianglog/django-vue-admin) | [![Gitee star](https://gitee.com/liqianglog/django-vue-admin/badge/star.svg?theme=white)](https://gitee.com/liqianglog/django-vue-admin) [![GitHub stars](https://img.shields.io/github/stars/liqianglog/django-vue-admin.svg?style=social&label=Stars)](https://github.com/liqianglog/django-vue-admin) | Management Dashboard based on
Vue2 + Element + D2Admin + Django. | +| [django-vue3-admin](https://gitee.com/huge-dream/django-vue3-admin) | [![Gitee star](https://gitee.com/huge-dream/django-vue3-admin/badge/star.svg?theme=white)](https://gitee.com/huge-dream/django-vue3-admin) [![GitHub stars](https://img.shields.io/github/stars/huge-dream/django-vue3-admin.svg?style=social&label=Stars)](https://github.com/huge-dream/django-vue3-admin) | Management Dashboard implemented based on
Vue3 + vue-next-admin + fastcrud + Django. | + +## plugins market 🔌 + +#### [Click here to view the latest development progress](https://rgej2wr12o.feishu.cn/base/KevWbAzaEazgD2s8SmKc36PJnwb?table=tblpongo56gp6zN9&view=vewpLA5Hdc) | [Plugin Market](https://bbs.django-vue-admin.com/plugMarket.html) + +| Plugin Name | Development Status | Description | +| ------------------------------------------------------------ | ------------------ | ------------------------------------------------------------ | +| [dvadmin3-celery 定时任务](https://bbs.django-vue-admin.com/plugMarket/129.html) | Released | Enables asynchronous tasks in dvadmin3, including task scheduling and record management | +| [dvadmin-celery 定时任务](https://bbs.django-vue-admin.com/plugMarket/115.html) | Released | Enables asynchronous tasks in dvadmin3, including task scheduling and record management | +| [dvadmin-sms 短信服务](https://bbs.django-vue-admin.com/plugMarket/128.html) | Released | Integrates SMS service plugins for various platforms | +| [dvadmin-vform 表单设计器](https://bbs.django-vue-admin.com/plugMarket/118.html) | Released | Low-code form designer plugin | +| [dvadmin-tenants 多租户管理](https://bbs.django-vue-admin.com/plugMarket/124.html) | Released | Saas mode for multi-tenancy management | +| [dvadmin-third 第三方用户管理](https://bbs.django-vue-admin.com/plugMarket/122.html) | Released | Plugin for managing third-party users | +| [dvadmin-ak-sk 加密密钥管理](https://bbs.django-vue-admin.com/plugMarket/120.html) | Released | Manages encryption keys for verifying authentication strings | +| [dvadmin-pay 支付插件](https://bbs.django-vue-admin.com/plugMarket/131.html) | Released | Payment plugin for dvadmin, supports WeChat Pay and Alipay | +| [dvadmin-uniapp](https://bbs.django-vue-admin.com/plugMarket/130.html) | Released | Uniapp plugin for dvadmin | +| dvadmin-cloud-storage 云存储插件 | Development | Plugin for storing files using various cloud storage providers | +| dvadmin-es 搜索插件 | Development | Search plugin for Elasticsearch | +| dvadmin-low-code-crud 低代码生成 | Development | Low-code generation plugin | +| dvadmin-flow 工作流插件 | Development | Workflow plugin | + +## before start project you need: ~~~ -Python >= 3.8.0 (推荐3.8+版本) -nodejs >= 14.0 (推荐最新) -Mysql >= 5.7.0 (可选,默认数据库sqlite3,推荐8.0版本) -Redis(可选,最新版) +Python >= 3.8.0 +nodejs >= 14.0 +Mysql >= 5.7.0 (Optional. The default database is sqlite3. 8.0 is recommended) +Redis(Optional, the latest edition) ~~~ -## 前端♝ +## frontend♝ ```bash -# 克隆项目 +# clone code git clone https://gitee.com/liqianglog/django-vue-admin.git -# 进入项目目录 +# enter code dir cd web -# 安装依赖 +# install dependence npm install --registry=https://registry.npm.taobao.org -# 启动服务 +# Start service npm run dev -# 浏览器访问 http://localhost:8080 -# .env.development 文件中可配置启动端口等参数 -# 构建生产环境 +# Visit http://localhost:8080 in your browser +# Parameters such as boot port can be configured in the #.env.development file +# Build the production environment # npm run build ``` - - -## 后端💈 +## backend💈 ~~~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 -或使用 gunicorn : +1. enter code dir cd backend +2. copy ./conf/env.example.py to ./conf dir,rename as env.py +3. in env.py configure database information + mysql database recommended version: 8.0 + mysql database character set: utf8mb4 +4. install pip dependence + pip3 install -r requirements.txt +5. Execute the migration command: + python3 manage.py makemigrations + python3 manage.py migrate +6. Initialization data + python3 manage.py init +7. Initialize provincial, municipal and county data: + python3 manage.py init_area +8. start backend + python3 manage.py runserver 0.0.0.0:8000 +or gunicorn : gunicorn -c gunicorn_conf.py application.asgi:application ~~~ -### 访问项目 +### visit backend swagger -- 访问地址:[http://localhost:8080](http://localhost:8080) (默认为此地址,如有修改请按照配置文件) -- 账号:`superadmin` 密码:`admin123456` +* visit url:[http://localhost:8080](http://localhost:8080) (The default address is this one. If you want to change it, follow the configuration file) +* account:`superadmin` password:`admin123456` - - - - -### docker-compose 运行 +### docker-compose ~~~shell -# 先安装docker-compose (自行百度安装),执行此命令等待安装,如有使用celery插件请打开docker-compose.yml中celery 部分注释 docker-compose up -d -# 初始化后端数据(第一次执行即可) +# Initialize backend data (first execution only) docker exec -ti dvadmin-django bash python manage.py makemigrations python manage.py migrate @@ -190,22 +182,20 @@ 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 +frontend url:http://127.0.0.1:8080 +backend url:http://127.0.0.1:8080/api +# Change 127.0.0.1 to your own public ip address on the server +account:`superadmin` password:`admin123456` -# docker-compose 停止 +# docker-compose stop docker-compose down -# docker-compose 重启 +# docker-compose restart docker-compose restart -# docker-compose 启动时重新进行 build +# docker-compose on start build docker-compose up -d --build ~~~ - - -## 演示图✅ +## Demo screenshot✅ ![image-01](https://foruda.gitee.com/images/1682179942561449504/020863bb_5074988.jpeg) @@ -231,8 +221,7 @@ docker-compose up -d --build ![image-12](https://foruda.gitee.com/images/1681118517168485285/f34152ba_5074988.png) -## 商业授权 +## Commercial License ![image-13](https://foruda.gitee.com/images/1681118527820910716/43a7c660_5074988.png) - diff --git a/README.zh.md b/README.zh.md new file mode 100644 index 0000000..4b19b86 --- /dev/null +++ b/README.zh.md @@ -0,0 +1,238 @@ +# Django-Vue-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) + +[English](./README.md) | [预 览](https://demo.django-vue-admin.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带来一点我们的色彩和颜色。 + +因为热爱,所以拥抱未来 + + + +🗓️ **「开发线路」** + +请留下您宝贵建议,打造更加完善的dvadmin [需求提交](https://rgej2wr12o.feishu.cn/share/base/form/shrcnsHNfeC9URj6RIOR3xPPD3f) | [需求线路图](https://rgej2wr12o.feishu.cn/base/KevWbAzaEazgD2s8SmKc36PJnwb) + + + +👩‍👦‍👦 **「征文大赛」** + +为促进社区的更好发展,现开展dvadmin征文大赛,更有 **永久商业授权** 等丰厚奖品等你来拿 [点我查看详情](https://bbs.django-vue-admin.com/question/462.html) + + + +## 平台简介 + +💡 [django-vue-admin](https://gitee.com/dvadmin/django-vue-admin) 是一套全部开源的快速开发平台,毫无保留给个人及企业免费使用。 + + + +* 🧑‍🤝‍🧑前端采用[D2Admin](https://github.com/d2-projects/d2-admin) 、[Vue](https://cn.vuejs.org/)、[ElementUI](https://element.eleme.cn/)。 +* 👭后端采用 Python 语言 Django 框架以及强大的 [Django REST Framework](https://pypi.org/project/djangorestframework)。 +* 👫权限认证使用[Django REST Framework SimpleJWT](https://pypi.org/project/djangorestframework-simplejwt),支持多终端认证系统。 +* 👬支持加载动态权限菜单,多方式轻松权限控制。 +* 💏特别鸣谢:[D2Admin](https://github.com/d2-projects/d2-admin) 、[Vue-Element-Admin](https://github.com/PanJiaChen/vue-element-admin)。 +* 💡 特别感谢[jetbrains](https://www.jetbrains.com/) 为本开源项目提供免费的 IntelliJ IDEA 授权。 + + + +## 在线体验 + +👩‍👧‍👦演示地址:[http://demo.django-vue-admin.com](http://demo.django-vue-admin.com) + +- 账号:superadmin + +- 密码:admin123456 + +👩‍👦‍👦文档地址:[https://django-vue-admin.com](https://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 [点击链接加入群聊](https://qm.qq.com/cgi-bin/qm/qr?k=ESpuF6A1Fcx0XrY4w6CzCvbnjI4kNsa0&jump_from=webapi) + +- 二维码 + + + +## 内置功能 + +1. 👨‍⚕️菜单管理:配置系统菜单,操作权限,按钮权限标识、后端接口权限等。 +2. 🧑‍⚕️部门管理:配置系统组织机构(公司、部门、角色)。 +3. 👩‍⚕️角色管理:角色菜单权限分配、数据权限分配、设置角色按部门进行数据范围权限划分。 +4. 🧑‍🎓权限权限:授权角色的权限范围。 +5. 👨‍🎓用户管理:用户是系统操作者,该功能主要完成系统用户配置。 +6. 👬接口白名单:配置不需要进行权限校验的接口。 +7. 🧑‍🔧字典管理:对系统中经常使用的一些较为固定的数据进行维护。 +8. 🧑‍🔧地区管理:对省市县区域进行管理。 +9. 📁附件管理:对平台上所有文件、图片等进行统一管理。 +10. 🗓️操作日志:系统正常操作日志记录和查询;系统异常信息日志记录和查询。 +11. 🔌[插件市场 ](https://bbs.django-vue-admin.com/plugMarket.html):基于Django-Vue-Admin框架开发的应用和插件。 + +## 源码地址 + +gitee地址(主推):[https://gitee.com/liqianglog/django-vue-admin](https://gitee.com/liqianglog/django-vue-admin)👩‍👦‍👦 + +github地址:[https://github.com/liqianglog/django-vue-admin](https://github.com/liqianglog/django-vue-admin)👩‍👦‍👦 + +| 项目 | Star | 简介 | +| ------------------------------------------------------------ | ------------------------------------------------------------ | -------------------------------------------- | +| [django-vue-admin](https://gitee.com/liqianglog/django-vue-admin) | [![Gitee star](https://gitee.com/liqianglog/django-vue-admin/badge/star.svg?theme=white)](https://gitee.com/liqianglog/django-vue-admin) [![GitHub stars](https://img.shields.io/github/stars/liqianglog/django-vue-admin.svg?style=social&label=Stars)](https://github.com/liqianglog/django-vue-admin) | 基于 Vue2 + element + d2admin + django 实现的管理后台 | +| [django-vue3-admin](https://gitee.com/huge-dream/django-vue3-admin) | [![Gitee star](https://gitee.com/huge-dream/django-vue3-admin/badge/star.svg?theme=white)](https://gitee.com/huge-dream/django-vue3-admin) [![GitHub stars](https://img.shields.io/github/stars/huge-dream/django-vue3-admin.svg?style=social&label=Stars)](https://github.com/huge-dream/django-vue3-admin) | 基于 Vue3 + vue-next-admin + fastcrud + django 实现的管理后台 | + +## 插件市场 🔌 + +#### [点我查看最新开发进度](https://rgej2wr12o.feishu.cn/base/KevWbAzaEazgD2s8SmKc36PJnwb?table=tblpongo56gp6zN9&view=vewpLA5Hdc) | [插件市场](https://bbs.django-vue-admin.com/plugMarket.html) + +| 插件名称 | 开发状态 | 简介 | +| --------------------------------------------------------- | -------- | ------------------------------------------------------------ | +| [dvadmin3-celery 定时任务](https://bbs.django-vue-admin.com/plugMarket/129.html) | 已发布 | 适用dvadmin3可快速使用异步任务,包含在线添加任务、任务记录等 | +| [dvadmin-celery 定时任务](https://bbs.django-vue-admin.com/plugMarket/115.html) | 已发布 | 适用dvadmin3可快速使用异步任务,包含在线添加任务、任务记录等 | +| [dvadmin-sms 短信服务](https://bbs.django-vue-admin.com/plugMarket/128.html) | 已发布 | 整合各端的短信服务插件 | +| [dvadmin-vform 表单设计器](https://bbs.django-vue-admin.com/plugMarket/118.html) | 已发布 | 低代码表单设计器插件 | +| [dvadmin-tenants 多租户管理](https://bbs.django-vue-admin.com/plugMarket/124.html) | 已发布 | 多租户的saas模式 | +| [dvadmin-third 第三方用户管理](https://bbs.django-vue-admin.com/plugMarket/122.html) | 已发布 | 第三方用户管理插件 | +| [dvadmin-ak-sk 加密密钥管理](https://bbs.django-vue-admin.com/plugMarket/120.html) | 已发布 | 用于加密认证字符串来验证认证字符串的密钥 | +| [dvadmin-pay 支付插件](https://bbs.django-vue-admin.com/plugMarket/131.html) | 已发布 | 适用于dvadmin的支付插件,支持微信支持、支付宝支付 | +| [dvadmin-uniapp](https://bbs.django-vue-admin.com/plugMarket/130.html) | 已发布 | 适用于dvadmin的uniapp插件 | +| dvadmin-cloud-storage 云存储插件 | 开发中 | 适用各种云存储进行存储插件 | +| dvadmin-es 搜索插件 | 开发中 | 适用于es的搜索插件 | +| dvadmin-low-code-crud 低代码生成 | 开发中 | 低代码生成插件 | +| dvadmin-flow 工作流插件 | 开发中 | 工作流插件 | + + + +## 准备工作 + +~~~ +Python >= 3.8.0 (推荐3.8+版本) +nodejs >= 14.0 (推荐最新) +Mysql >= 5.7.0 (可选,默认数据库sqlite3,推荐8.0版本) +Redis(可选,最新版) +~~~ + +## 前端♝ + +```bash +# 克隆项目 +git clone https://gitee.com/liqianglog/django-vue-admin.git + +# 进入项目目录 +cd web + +# 安装依赖 +npm install --registry=https://registry.npm.taobao.org + +# 启动服务 +npm run dev +# 浏览器访问 http://localhost:8080 +# .env.development 文件中可配置启动端口等参数 +# 构建生产环境 +# npm 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 +或使用 gunicorn : + gunicorn -c gunicorn_conf.py application.asgi:application +~~~ + +### 访问项目 + +- 访问地址:[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 dvadmin-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/1682179942561449504/020863bb_5074988.jpeg) + +![image-02](https://foruda.gitee.com/images/1682179701820334814/f20eb5e8_5074988.png) + +![image-03](https://foruda.gitee.com/images/1682179718209143602/e6b6a4b1_5074988.png) + +![image-04](https://foruda.gitee.com/images/1681118349561624452/d917f8bc_5074988.jpeg) + +![image-05](https://foruda.gitee.com/images/1681118368415555513/03a8db63_5074988.jpeg) + +![image-06](https://foruda.gitee.com/images/1681118379484890540/6f9caa75_5074988.jpeg) + +![image-07](https://foruda.gitee.com/images/1681118387902110958/86d86d80_5074988.jpeg) + +![image-08](https://foruda.gitee.com/images/1681118398381431700/1e3fa0ec_5074988.jpeg) + +![image-09](https://foruda.gitee.com/images/1681118450796081811/aa00a240_5074988.png) + +![image-10](https://foruda.gitee.com/images/1681118482618114892/5cc2e297_5074988.png) + +![image-11](https://foruda.gitee.com/images/1681118492497719384/52a47252_5074988.png) + +![image-12](https://foruda.gitee.com/images/1681118517168485285/f34152ba_5074988.png) + +## 商业授权 + +![image-13](https://foruda.gitee.com/images/1681118527820910716/43a7c660_5074988.png) + +