Improve README

Veal98 · Feb 17, 2021 · ef31060 · ef31060
1 parent cd62683
commit ef31060
Show file tree

Hide file tree

Showing 5 changed files with 27 additions and 33 deletions.
diff --git a/README.md b/README.md
@@ -16,6 +16,10 @@
 
 </div>
 
+## 📚 项目简介
+
+Echo 是一套前后端不分离的开源社区系统，基于目前主流 Java Web 技术栈（SpringBoot + MyBatis + MySQL + Redis + Kafka + Elasticsearch + Spring Security + ...），并提供详细的开发文档和配套教程。包含帖子、评论、私信、系统通知、点赞、关注、搜索、用户设置、数据统计等模块。
+
 **源码链接**：已托管在 Github 和 Gitee：
 
 - Github：[https://github.com/Veal98/Echo](https://github.com/Veal98/Echo)
@@ -31,13 +35,6 @@
 
 **文档地址**：文档通过 <u>Docsify + Gitee Pages</u> 生成，国内访问速度较快，在线访问地址：[https://veal98.gitee.io/echo](https://veal98.gitee.io/echo)
 
-
-## 📚 从本项目你能学到什么
-
-- 学会主流的 Java Web 开发技术和框架（Spring、SpringBoot、Spring MVC、MyBatis、MySQL、Redis、Kafka、Elasticsearch、Spring Security 等）
-- 了解一个真实的 Web 项目从开发到部署的整个流程（本项目配套有大量图例和详细教程，以帮助小伙伴快速上手）
-- 掌握本项目中涉及的核心技术点以及常见面试题和解析
-
 ## 💻 核心技术栈
 
 后端：
@@ -281,7 +278,9 @@
 - Elasticsearch
 - Kafka
 
-另外，还需要事件建好数据库表，详细见下文。
+另外，还需要事件建好数据库 greatecommunity，然后依次运行项目 sql 文件夹下的这几个 sql 文件建立数据库表：
+
+<img src="https://gitee.com/veal98/images/raw/master/img/20210217134928.png" style="width:386px" />
 
 ## 📜 数据库设计
 

diff --git a/docs/README.md b/docs/README.md
@@ -2,6 +2,10 @@
 
 ---
 
+## 📚 项目简介
+
+Echo 是一套前后端不分离的开源社区系统，基于目前主流 Java Web 技术栈（SpringBoot + MyBatis + MySQL + Redis + Kafka + Elasticsearch + Spring Security + ...），并提供详细的开发文档和配套教程。包含帖子、评论、私信、系统通知、点赞、关注、搜索、用户设置、数据统计等模块。
+
 **源码链接**：已托管在 Github 和 Gitee：
 
 - Github：[https://github.com/Veal98/Echo](https://github.com/Veal98/Echo)
@@ -17,17 +21,6 @@
 
 **文档地址**：文档通过 <u>Docsify + Gitee Pages</u> 生成，国内访问速度较快，在线访问地址：[https://veal98.gitee.io/echo](https://veal98.gitee.io/echo)
 
-## 📚 从本项目你能学到什么
-
-- 学会主流的 Java Web 开发技术和框架（Spring、SpringBoot、Spring MVC、MyBatis、MySQL、Redis、Kafka、Elasticsearch、Spring Security 等）
-- 了解一个真实的 Web 项目从开发到部署的整个流程（本项目配套有大量图例和详细教程，以帮助小伙伴快速上手）
-- 掌握本项目中涉及的核心技术点以及常见面试题和解析
-
-项目托管在 Gitee 和 Github：
-
-- Gitee：[https://gitee.com/veal98/Echo](https://gitee.com/veal98/Echo)
-- Github：[https://github.com/Veal98/Echo](https://github.com/Veal98/Echo)
-
 ## 💻 核心技术栈
 
 后端：
@@ -233,6 +226,7 @@
 
 以下是我觉得本项目还可以添加的功能，同样欢迎各位小伙伴提 issue 指出还可以增加哪些功能，或者直接提 PR 实现该功能：
 
+- [ ] 发帖支持 Markdown 格式
 - [ ] 忘记密码（发送邮件找回密码）
 - [ ] 查询我的点赞
 - [ ] 管理员对帖子的二次点击取消置顶功能
@@ -271,7 +265,9 @@
 - Elasticsearch
 - Kafka
 
-另外，还需要事件建好数据库表，详细见下文。
+另外，还需要事件建好数据库 greatecommunity，然后依次运行项目 sql 文件夹下的这几个 sql 文件建立数据库表：
+
+<img src="https://gitee.com/veal98/images/raw/master/img/20210217134928.png" style="width:386px" />
 
 ## 📜 数据库设计
 
@@ -355,7 +351,7 @@ CREATE TABLE `message` (
 ) ENGINE=InnoDB DEFAULT CHARSET=utf8;
 ```
 
-## 🌌 理想的部署架构
+## 🌌 部署架构
 
 我每个都只部署了一台，以下是理想的部署架构：
 

diff --git a/src/main/resources/application-develop.properties b/src/main/resources/application-develop.properties
@@ -15,7 +15,6 @@ spring.datasource.url = jdbc:mysql://127.0.0.1:3306/greatecommunity?characterEnc
 spring.datasource.username = root
 spring.datasource.password = root
 # Mysql 5.0+ 版本使用 com.mysql.jdbc.Driver
-# 如果是 8.0+ 的版本请改成 com.mysql.cj.jdbc.Driver
 spring.datasource.driver-class-name = com.mysql.jdbc.Driver
 
 # Mybatis

diff --git a/src/main/resources/templates/site/forget.html b/src/main/resources/templates/site/forget.html
@@ -1,13 +1,13 @@
 <!doctype html>
-<html lang="en">
+<html lang="en" xmlns:th="http://www.thymeleaf.org">
 <head>
 	<meta charset="utf-8">
 	<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
-	<link rel="icon" href="https://static.nowcoder.com/images/logo_87_87.png"/>
-	<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/css/bootstrap.min.css" crossorigin="anonymous">
-	<link rel="stylesheet" href="../css/global.css" />
-	<link rel="stylesheet" href="../css/login.css" />
-	<title>牛客网-忘记密码</title>
+	<link rel="icon" type="shortcut icon" th:href="@{/img/favicon.ico}" />
+	<link rel="stylesheet" type="text/css" th:href="@{/css/bootstrap.min.css}" />
+	<link rel="stylesheet" type="text/css" th:href="@{/css/global.css}" />
+	<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap-icons@1.3.0/font/bootstrap-icons.css">
+	<title>Echo - 忘记密码</title>
 </head>
 <body>
 	<div class="nk-container">
@@ -108,9 +108,9 @@
 
 	</div>
 
-	<script src="https://code.jquery.com/jquery-3.3.1.min.js" crossorigin="anonymous"></script>
-	<script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.14.7/umd/popper.min.js" crossorigin="anonymous"></script>
-	<script src="https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/js/bootstrap.min.js" crossorigin="anonymous"></script>
-	<script src="../js/global.js"></script>
+	<script th:src="@{/js/jquery-3.1.0.min.js}"></script>
+	<script th:src="@{/js/popper.min.js}"></script>
+	<script th:src="@{/js/bootstrap.min.js}"></script>
+	<script th:src="@{/js/global.js}"></script>
 </body>
 </html>
diff --git a/src/main/resources/templates/site/my-post.html b/src/main/resources/templates/site/my-post.html
@@ -7,7 +7,7 @@
 	<link rel="stylesheet" type="text/css" th:href="@{/css/bootstrap.min.css}" />
 	<link rel="stylesheet" type="text/css" th:href="@{/css/global.css}" />
 	<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap-icons@1.3.0/font/bootstrap-icons.css">
-	<title>Echo - 个人主页</title>
+	<title>Echo - 我的帖子</title>
 </head>
 <body>
 	<div class="nk-container">