docs: update README.md

This commit is contained in:
xiongxiaoyang
2022-05-22 21:43:47 +08:00
parent d6849bc5a2
commit 547bf00f46

View File

@@ -13,32 +13,17 @@ https://201206030.github.io
[基于 Spring Boot 3 + Vue 3 开发的前后端分离学习型小说项目。](https://github.com/201206030/novel) [基于 Spring Boot 3 + Vue 3 开发的前后端分离学习型小说项目。](https://github.com/201206030/novel)
#### 微服务版
[Github](https://github.com/201206030/novel-cloud) | [码云](https://gitee.com/novel_dev_team/novel-cloud)
#### 演示地址 #### 演示地址
[点击前往](http://47.106.243.172:8888/) [点击前往](http://47.106.243.172:8888/)
#### 项目介绍 #### 项目介绍
小说精品屋-plus是在[小说精品屋](https://github.com/201206030/fiction_house)的基础上,去除了漫画和弹幕模块,专注于小说,是一个多端(PC、WAP)阅读、功能完善的原创文学CMS系统,由前台门户系统、作家后台管理系统、平台后台管理系统、爬虫管理系统等多个子系统构成,支持会员充值、订阅模式、新闻发布和实时统计报表等功能。 novel-plus 是一个多端(PC、WAP)阅读,功能完善的原创文学 CMS 系统。由前台门户系统、作家后台管理系统、平台后台管理系统和爬虫管理系统等多个子系统构成,包括小说推荐、作品检索、小说排行、小说阅读、小说评论、会员中心、作家专区等功能,支持自定义多模版、可拓展的多种小说内容存储方式(内置数据库分表存储和 TXT 文本存储)、阅读主题切换、多爬虫源自动采集和更新数据、会员充值、订阅模式、新闻发布和实时统计报表。
小说精品屋-plus重新进行了数据库设计、代码重构和功能增强,提升了程序整体的可读性和性能,增加了很多商用特性。主要升级如下:
- [x] 数据库重新设计,结构调整。
- [x] 服务端代码重构,MyBatis3升级为MyBatis3DynamicSql。
- [x] 移动站与PC站站点分离,浏览器自动识别跳转。
- [x] PC站UI更新。
- [x] 支持前端模版自定义,内置多套模版。
- [x] 可拓展的多种方式存储小说内容,内置数据库(分表)存储和TXT文本存储。
- [x] 新闻模块。
- [x] 排行榜。
- [x] 小说评论模块。
- [x] 阅读主题模块。
- [x] 作家专区。
- [x] 充值。
- [x] 订阅。
- [x] 后台管理系统。
- [x] 爬虫管理系统。
#### 项目结构 #### 项目结构
@@ -54,7 +39,7 @@ novel-plus -- 父工程
#### 技术选型 #### 技术选型
| 技术 | 说明 | 技术 | 说明
| -------------------- | --------------------------- |---------------------| ---------------------------
| Spring Boot | Spring 应用快速开发脚手架 | Spring Boot | Spring 应用快速开发脚手架
| MyBatis | 持久层 ORM 框架 | MyBatis | 持久层 ORM 框架
| MyBatis Dynamic SQL | Mybatis 动态 sql | MyBatis Dynamic SQL | Mybatis 动态 sql
@@ -66,27 +51,16 @@ novel-plus -- 父工程
| Shiro | 安全框架 | Shiro | 安全框架
| Ehcache | Java 进程内缓存框架(默认缓存) | Ehcache | Java 进程内缓存框架(默认缓存)
| Redis | 分布式缓存(缓存替换方案,默认关闭,一行配置开启) | Redis | 分布式缓存(缓存替换方案,默认关闭,一行配置开启)
| ElasticSearch | 搜索引擎(搜索增强方案,默认关闭,一行配置开启) | Elasticsearch | 搜索引擎(搜索增强方案,默认关闭,一行配置开启)
| RabbitMq | 消息队列(流量削峰,默认关闭,一行配置开启) | RabbitMQ | 消息队列(流量削峰,默认关闭,一行配置开启)
| OSS | 阿里云对象存储服务(图片存储方式之一,一行配置即可切换) | Aliyun OSS | 阿里云对象存储服务(图片存储方式之一,一行配置即可切换)
| FastDfs |开源轻量级分布式文件系统(图片存储方式之一,一行配置即可切换) | FastDFS | 开源轻量级分布式文件系统(图片存储方式之一,一行配置即可切换)
| Redisson | 实现分布式锁 | Redisson | 实现分布式锁
| Lombok | 简化对象封装工具 | Lombok | 简化对象封装工具
| Docker | 应用容器引擎 | Docker | 应用容器引擎
| Mysql | 数据库服务 | MySQL | 数据库服务
| Thymeleaf | 模板引擎 | Thymeleaf | 模板引擎
| Layui | 前端UI | Layui | 前端 UI 框架
#### 开发工具
感谢Jetbrains公司提供的免费License。
[![index]( https://s3.ax1x.com/2021/01/14/sdHsJg.png )]( https://www.jetbrains.com/?from=小说精品屋)
#### 接口文档
[点击查看接口文档示例](doc/api/api.md)
#### 橙色主题模版截图 #### 橙色主题模版截图
##### PC站截图 ##### PC站截图
@@ -207,7 +181,7 @@ novel-plus -- 父工程
#### 安装步骤(源码,小白请看其他安装教程) #### 安装步骤(源码,小白请看其他安装教程)
部分环境(如新版Mac OS系统)获取不到主机IP,需要手动修改host文件,增加IP-主机名(通过hostname命令查看主机名)的映射。 部分环境(如新版 Mac OS 系统)获取不到主机 IP,需要手动修改 hosts 文件,增加 IP-主机名(通过 hostname 命令查看主机名)的映射。
##### 数据库安装: ##### 数据库安装:
@@ -279,7 +253,7 @@ docker安装教程:[点击前往](https://my.oschina.net/java2nb/blog/4271989)
#### 代码仓库 #### 代码仓库
GitHub仓库地址: https://github.com/201206030/novel-plus Github 仓库地址: https://github.com/201206030/novel-plus
Gitee 仓库地址: https://gitee.com/novel_dev_team/novel-plus Gitee 仓库地址: https://gitee.com/novel_dev_team/novel-plus