diff --git a/web/README.md b/web/README.md index 66a291f9f2ec033b73d50935adab222a361778f1..b1b424baf7bf9cf47030c6100c49c2c82a979a26 100644 --- a/web/README.md +++ b/web/README.md @@ -1,85 +1,110 @@ -# PaoDjangoAdmin - -

PaoDjangoAdmin

-

基于Go前后端分离架构,代码精简,开箱即用,前端紧随前沿 Vue3.0 + TypeScript + vite3 + Element-plus技术

- - -## 🌈平台简介 - -* 对前后端进行了大部分功能的封装,使用起来更加简洁,功能逻辑清晰,能快速上手学习,并用在生产中。 -* 后端采用Django进行开发 -* 完善的权限认证系统:完善的权限认证系统,包含,菜单按钮权限,api权限,部门权限。 - -## 🏭在线体验 - -演示地址: 帐号:admin 密码:123456 - - -**> 未来会补充文档和视频,方便友友们使用!** - -## 🚧系统截图 - -更多功能请访问系统体验 - -## 联系我们 - -## ⚡ 内置功能 - -- **`用户管理`** - _用户是系统操作者,该功能主要完成系统用户配置。._ -- **`部门管理`** - _配置系统组织机构(公司、部门、小组),树结构展现支持数据权限。_ -- **`岗位管理`** - _配置系统用户所属担任职务。_ -- **`菜单管理`** - _配置系统菜单,操作权限,按钮权限标识等。_ -- **`角色管理`** - _角色菜单,API权限分配、设置角色按机构进行数据范围权限划分。_ -- **`字典管理`** - _对系统中经常使用的一些较为固定的数据进行维护。_ -- **`参数管理`** - _对系统动态配置常用参数。_ -- **`通知公告`** - _系统通知公告信息发布维护_ -- **`日志系统`** - _记录日志,更直观浏览_ -- **`系统接口`** - _根据业务代码自动生成相关的api接口文档。_ -- **`服务监控`** - _监视当前系统CPU、内存、磁盘、堆栈等相关信息。_ -- **`代码生成`** - _可直接通过框架生成前后端基础业务代码(go、vue),减少开发时间。_ -- **`组态大屏设计器`** - _通过拖拉拽直接生成组态、大屏。_ -- **`规则链设计`** - _物联网规则链过滤_ -- **`报表设计`** - _数据报表设计_ -- **`产品管理`** - _设备的产品管理_ -- **`设备管理`** - _设备的管理_ - - ---- -前端工程结构 ---- +# DjangoVue3Admin + +## 项目简介 +DjangoVue3Admin 是一个基于 Django 和 Vue3 的后台管理系统,提供完善的用户权限管理、系统监控、任务调度等功能,适用于企业级应用开发。 + +## 许可证 +本项目遵循 MIT 许可证。 + +## 技术架构 +### 后端技术栈 +- Python 3.9+ +- Django 4.0+ +- Django REST Framework +- Celery(任务调度) +- PostgreSQL/MySQL(数据库支持) + +### 前端技术栈 +- Vue 3 + TypeScript +- Vite 构建工具 +- Element Plus UI 框架 +- WebSocket 实时通信 +- Sass 样式预处理器 + +## 功能特点 +1. **用户权限管理** + - 用户登录认证(JWT) + - 角色权限分配 + - 数据权限控制 +2. **系统功能** + - 部门管理 + - 岗位管理 + - 菜单管理 + - 字典管理 +3. **系统监控** + - 系统资源监控(CPU、内存、磁盘等) + - 定时任务管理 + - 日志管理 +4. **系统工具** + - 邮件发送 + - 文件管理 + - 消息中心 + +## 部署说明 +### 环境要求 +- Python 3.9+ +- Node.js 16+ +- Docker(可选) +- PostgreSQL 或 MySQL 数据库 + +### 部署步骤 +#### 1. Docker 部署(推荐) +**启动所有服务** +```bash +docker-compose up -d +``` +**仅启动后端服务** +```bash +docker-compose up -d django ``` -├── src -│ ├── api # Api ajax 等 -│ ├── assets # 本地静态资源 -│ ├── i18n # 国际化 -│ ├── components # 业务通用组件 -│ ├── layout # layout -│ ├── theme # css主题样式 -│ ├── router # Vue-Router -│ ├── store # Vuex -│ ├── utils # 工具库 -│ ├── views # 业务页面入口和常用模板 -│ ├── App.vue # Vue 模板入口 -│ └── main.ts # Vue 入口 TS -├── README.md -└── package.json + +**仅启动前端服务** +```bash +docker-compose up -d web ``` -## 后端工程结构 +#### 2. 常规部署 +**后端部署** +```bash +# 安装依赖 +pip install -r backend/requirements.txt -| 目录 | 功能 | -|:----------:|:-------------------------------------| -| `deploy` | 部署文件,本项目部署是利用`K3S`进行部署的,因此里面的文档为部署文档 | -| `apps` | 基本功能,所有功能模块全在这里面 | -| `iothub` | 设备接入层,设备数据上报在这里处理,使用emqx的hook模式 | -| `resource` | 项目启动或生成的资源文件存放目录。 | -| `pkg` | 所有开发过程中的全局通用代码。 | -| `uploads` | 存储上传的文件的地方 | +# 数据库迁移 +cd backend +python manage.py migrate -更多功能请访问系统。 +# 初始化数据(可选) +python manage.py init +# 启动服务 +python manage.py runserver 0.0.0.0:8000 +``` -## ❤特别鸣谢 +**前端部署** +```bash +cd web +npm install +npm run build # 生产环境 +npm run dev # 开发环境 +``` -* 感谢[VUE-NEXT-ADMIN](https://gitee.com/lyt-top/vue-next-admin) +### 初始账号 +- 用户名:admin +- 密码:admin123456 + +## 开发指南 +### 后端开发 +- 使用 Django ORM 进行数据库操作 +- 使用 DRF 编写 RESTful API +- 使用 Celery 实现异步任务处理 +- 使用 JWT 实现用户认证 + +### 前端开发 +- 使用 Vue3 Composition API 开发组件 +- 使用 Vite 提升开发体验 +- 使用 TypeScript 提高代码质量 +- 使用 Sass 实现主题定制 + +## 演示图 +请参考 `web/README.md` 中的系统截图部分。 \ No newline at end of file