📝文档(other): update README.md

2024-03-20 14:16:10 +08:00
parent 06272c7630
commit 21ea22e444
3 changed files with 135 additions and 46 deletions
--- a/README.md
+++ b/README.md
@@ -1 +1,90 @@
-# schisandra-cloud-album-front
+# schisandra-cloud-album-front（README模板）
+# 云相册
+
+## 项目介绍
+
+基于Spring Boot 2.7.4、Spring Cloud 2021.0.3、
+MyBatis-Plus 3.5.1、Spring Security 5.7.1、Redis、Vue3、Element Plus
+
+前后端分离的云相册系统，包括用户模块、相册模块、图片模块、标签模块、评论模块、点赞模块、分享模块
+
+
+## 项目演示
+
+- 项目地址：https://github.com/schisandra/schisandra-cloud-album
+- 演示地址：http://47.104.244.143:8080/
+
+## 项目截图
+
+![登录](https://images.gitee.com/uploads/images/2022/0516/160755_96237180_562353.png "屏幕截图.png")		
+
+![注册](https://images.gitee.com/uploads/images/2022/0516/160755_76556491_562353.png "屏幕截图.png")
+
+![相册](https://images.gitee.com/uploads/images/2022/0516/160755_04645178_562353.png "屏幕截图.png")
+
+![图片](https://images.gitee.com/uploads/images/2022/0516/160755_05011624_562353.png "屏幕截图.png")
+
+![标签](https://images.gitee.com/uploads/images/2022/0516/160755_54512063_562353.png "屏幕截图.png")
+
+![评论](https://images.gitee.com/uploads/images/2022/0516/160755_19463001_562353.png "屏幕截图.png")
+
+![点赞](https://images.gitee.com/uploads/images/2022/0516/160755_61956190_562353.png "屏幕截图.png")
+
+![分享](https://images.gitee.com/uploads/images/2022/0516/160755_13948572_562353.png "屏幕截图.png")
+
+
+## 项目运行
+
+- 下载项目
+- 修改application.yml中的数据库连接信息
+- 修改application-dev.yml中的Redis连接信息
+- 运行数据库脚本
+- 运行项目
+- 浏览器访问：http://localhost:8080/
+- 用户名：admin
+- 密码：123456
+
+
+## 项目依赖
+
+- Spring Boot 2.7.4
+- Spring Cloud 2021.0.3
+- Spring Security 5.7.1
+- MyBatis-Plus 3.5.1
+- MySQL 8.0.28
+- Redis 6.2.6
+- Nacos 2.0.3
+- Seata 1.5.2
+- Sentinel 1.8.4
+- RocketMQ 4.9.2
+- Elasticsearch 7.17.7
+- Kibana 7.17.7
+- Logstash 7.17.7
+- Nginx 1.21.6
+- JWT 0.9.1
+- Lombok 1.18.20
+- Hutool 5.8.18
+- PageHelper 1.4.1
+
+
+## 项目功能
+
+- 用户管理：用户是系统操作者，该功能主要完成系统用户配置。
+- 角色管理：角色菜单权限分配、设置角色按机构进行数据范围权限划分。
+- 菜单管理：配置系统菜单，操作权限，按钮权限标识等。
+- 部门管理：配置系统组织机构（公司、部门、小组），树结构展现支持数据权限。
+- 字典管理：对系统中经常使用的一些较为固定的数据进行维护。
+- 参数管理：对系统动态配置常用参数。
+- 通知公告：系统通知公告信息发布维护。
+- 操作日志：系统正常操作日志记录和查询；系统异常信息日志记录和查询。
+- 登录日志：系统登录日志记录查询包含登录异常。
+- 定时任务：在线（添加、修改、删除)任务调度包含执行结果日志。
+- 代码生成：前后端代码的生成（java、html、xml、sql）支持CRUD下载 。
+- 系统接口：根据业务代码自动生成相关的api接口文档。
+- 服务监控：监视当前系统CPU、内存、磁盘、堆栈等相关信息。
+- 在线构建器：拖动表单元素生成相应的HTML代码。
+- 代码生成器：前后端代码的生成（java、html、xml、sql）支持CRUD下载 。
+- 系统接口：根据业务代码自动生成相关的api接口文档。
+- 服务监控：监视当前系统CPU、内存、磁盘、堆栈等相关信息。
+
+
--- a/commitlint.config.js
+++ b/commitlint.config.js
@@ -1,32 +1,32 @@
 module.exports = {
-	extents: ['@commitlint/config-conventional'],
-	rules: {
-		'body-leading-blank': [1, 'always'],
-		'footer-leading-blank': [1, 'always'],
-		'header-max-length': [2, 'always', 72],
-		'scope-case': [2, 'always', 'lower-case'],
-		'subject-case': [2, 'never', ['sentence-case', 'start-case', 'pascal-case', 'upper-case']],
-		'subject-empty': [2, 'never'],
-		'subject-full-stop': [2, 'never', '.'],
-		'type-case': [2, 'always', 'lower-case'],
-		'type-empty': [2, 'never'],
-		'type-enum': [
-			2,
-			'always',
-			[
-				'build',
-				'chore',
-				'ci',
-				'docs',
-				'feat',
-				'fix',
-				'improvement',
-				'perf',
-				'refactor',
-				'revert',
-				'style',
-				'test'
-			]
-		]
-	}
+	extents: ['@commitlint/config-conventional']
+	// rules: {
+	// 	'body-leading-blank': [1, 'always'],
+	// 	'footer-leading-blank': [1, 'always'],
+	// 	'header-max-length': [2, 'always', 72],
+	// 	'scope-case': [2, 'always', 'lower-case'],
+	// 	'subject-case': [2, 'never', ['sentence-case', 'start-case', 'pascal-case', 'upper-case']],
+	// 	'subject-empty': [2, 'never'],
+	// 	'subject-full-stop': [2, 'never', '.'],
+	// 	'type-case': [2, 'always', 'lower-case'],
+	// 	'type-empty': [2, 'never'],
+	// 	'type-enum': [
+	// 		2,
+	// 		'always',
+	// 		[
+	// 			'build',
+	// 			'chore',
+	// 			'ci',
+	// 			'docs',
+	// 			'feat',
+	// 			'fix',
+	// 			'improvement',
+	// 			'perf',
+	// 			'refactor',
+	// 			'revert',
+	// 			'style',
+	// 			'test'
+	// 		]
+	// 	]
+	// }
 }
--- a/src/utils/storage/storage.ts
+++ b/src/utils/storage/storage.ts
@@ -1,23 +1,23 @@
 /* 存储数据 */
 export const setItem = (key: any, value: any) => {
 	// 将数组、对象类型的数据转换为 JSON 格式字符串进行存储
-    if (typeof value === "object") {
-        value = JSON.stringify(value);
+	if (typeof value === 'object') {
+		value = JSON.stringify(value)
 	}
-    window.localStorage.setItem(key, value);
-};
+	window.localStorage.setItem(key, value)
+}

 /* 获取数据 */
 export const getItem = (key: any) => {
-    const data:any = window.localStorage.getItem(key);
+	const data: any = window.localStorage.getItem(key)
 	try {
-        return JSON.parse(data);
+		return JSON.parse(data)
 	} catch (err) {
-        return data;
+		return data
 	}
-};
+}

 /* 删除数据 */
 export const removeItem = (key: any) => {
-    window.localStorage.removeItem(key);
-};
+	window.localStorage.removeItem(key)
+}