From bf4f93b11bf10afb5f52f70ee7c635e389e24145 Mon Sep 17 00:00:00 2001
From: water-zhi <18835400919@163.com>
Date: Tue, 23 May 2023 02:17:16 +0000
Subject: [PATCH] =?UTF-8?q?=E6=9B=B4=E6=96=B0=20'README.md'?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
更新README
---
README.md | 136 +++++++++++++++++++++++++++++++++++++++++++++++++++++-
1 file changed, 134 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index 9d2cb45..f4fbb1a 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,135 @@
-# MyBlog
+## 博客简介
-基于Ruoyi-vue-plus二次开源的个人博客系统
\ No newline at end of file
+
+> 使用RuoYi-Vue-Plus 作为博客的后端框架
+
+> 项目代码、文档 均开源免费遵循开源协议在项目中保留开源协议文件即可
+
+### 系统演示功能暂未更新到最新代码,具体实现以最新代码效果为准
+
+### 系统演示出现bug等问题最新仓库代码已解决,请优先关注群内公告更新消息
+
+### 建议拉取代码后删除sys_oss中的全部代码,不然会影响文件管理页面的访问
+
+### :演示涉及到文件或者图片上传需要自行修改文件配置模块,写上自己的云端账密,使用后务必记住删除
+
+### : 演示模式三方登录逻辑暂未体现
+
+> 系统演示: 前台 http://water-zhi.cn 后台:http://admin.water-zhi.cn
+>
+> ## 部署博客的操作步骤文章与问题询问请进群:551275273
+
+## 业务功能
+
+| 功能 | 介绍 |
+| ---------- | ------------------------------------------------------------ |
+| 用户管理 | 用户是系统操作者,该功能主要完成系统用户配置。 |
+| 部门管理 | 配置系统组织机构(公司、部门、小组),树结构展现支持数据权限。 |
+| 岗位管理 | 配置系统用户所属担任职务。 |
+| 菜单管理 | 配置系统菜单,操作权限,按钮权限标识等。 |
+| 角色管理 | 角色菜单权限分配、设置角色按机构进行数据范围权限划分。 |
+| 字典管理 | 对系统中经常使用的一些较为固定的数据进行维护。 |
+| 参数管理 | 对系统动态配置常用参数。 |
+| 通知公告 | 系统通知公告信息发布维护。 |
+| 操作日志 | 系统正常操作日志记录和查询;系统异常信息日志记录和查询。 |
+| 登录日志 | 系统登录日志记录查询包含登录异常。 |
+| 文件管理 | 系统文件上传、下载等管理。 |
+| 定时任务 | 在线(添加、修改、删除)任务调度包含执行结果日志。 |
+| 代码生成 | 前后端代码的生成(java、html、xml、sql)支持CRUD下载 。 |
+| 系统接口 | 根据业务代码自动生成相关的api接口文档。 |
+| 服务监控 | 监视集群系统CPU、内存、磁盘、堆栈、在线日志、Spring相关配置等。 |
+| 缓存监控 | 对系统的缓存信息查询,命令统计等。 |
+| 在线构建器 | 拖动表单元素生成相应的HTML代码。 |
+| 连接池监视 | 监视当前系统数据库连接池状态,可进行分析SQL找出系统性能瓶颈。 |
+| 使用案例 | 系统的一些功能案例 |
+
+## 博客模块介绍
+
+| 包 | 介绍 |
+| --------- | ---------------------------------------------- |
+| blogutils | 博客后台中通用的方法。 |
+| domain | 实体层 |
+| domain-bo | 前端后台管理系统给后端返回的数据(查询条件)。 |
+| domain-vo | 后端给前端后台管理系统返回的数据层。 |
+| dto | 后端给前端前台界面返回的数据 |
+| dto-vo | 前端的前台界面给后端返回的数据 |
+| domain-es | es索引对应查询的实体类 |
+
+## 博客特点:
+
+- 项目规范,属于企业级博客
+- 鉴权使用了sa-token极大的降低了与项目的耦合度,代替了spring-security
+- 标签与分类动态添加
+- 弹幕强留言
+- 文章推荐等功能
+- 多搜索模式
+- 使用just-auth集成三方登录,便于拓展
+- 前台参考"Hexo"的"Butterfly"设计
+- 后台根据ruoyi-vue-plus开发十分贴合企业级开发规范
+- 整合了easy_es mail等流行框架
+
+## 使用技术:
+
+### 前端:前端: vue + vuex + vue-router + axios + vuetify + element + echarts
+
+### 后端: SpringBoot + easy_es + nginx + docker + sa-token + Swagger2 + MyBatisPlus + Mysql + Redis + elasticsearch + RabbitMQ + MaxWell + Websocket
+
+
+## 存储:使用当前主流的三方云端,cos/oss/七牛等动态切换
+
+## 运行环境:服务器:至少1核2G(关闭es)
+
+
+## 加群与捐献 🐧群:551275273
+
+
+
+## 捐献作者
+
+开源博主创作不易!
+
+ | + |
+ | + |
+ | + |
+ | + |
+ | + |
+ | + |
+ | + |
+ | + |