From 7c0ff5e9ceb2f5ceb8aed8ed2e81050b3cf995c9 Mon Sep 17 00:00:00 2001 From: xiongxiaoyang <1179705413@qq.com> Date: Tue, 16 Aug 2022 21:37:02 +0800 Subject: [PATCH] Update README.md --- README.md | 111 ++++++++++-------------------------------------------- 1 file changed, 19 insertions(+), 92 deletions(-) diff --git a/README.md b/README.md index 9e95339..77e44d1 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,9 @@ -[![index]( https://youdoc.github.io/img/tencent.jpg )]( https://cloud.tencent.com/act/cps/redirect?redirect=2446&cps_key=736e609d66e0ac4e57813316cec6fd0b&from=console ) +

+ +

+ +------ +

Java 17 Spring Boot 3 @@ -12,13 +17,17 @@ ## 项目简介 -novel 是一套基于时下**最新** Java 技术栈 Spring Boot 3 + Vue 3 开发的前后端分离的**学习型**小说项目,配备详细的项目教程手把手教你**从零开始**开发上线一个生产级别的 Java 系统,由小说门户系统、作家后台管理系统、平台后台管理系统、爬虫管理系统等多个子系统构成。包括小说推荐、作品检索、小说排行榜、小说阅读、小说评论、充值订阅、新闻发布等功能。 +novel 是一套基于时下**最新** Java 技术栈 Spring Boot 3 + Vue 3 开发的前后端分离**学习型** +小说项目,配备[保姆级教程](https://docs.xxyopen.com/course/novel)手把手教你**从零开始**开发上线一套生产级别的 Java +系统,由小说门户系统、作家后台管理系统、平台后台管理系统等多个子系统构成。包括小说推荐、作品检索、小说排行榜、小说阅读、小说评论、会员中心、作家专区、充值订阅、新闻发布等功能。 ## 项目地址 - 后端项目(更新中):[GitHub](https://github.com/201206030/novel) | [码云](https://gitee.com/novel_dev_team/novel) -- 前端项目(更新中):[GitHub](https://github.com/201206030/novel-front-web) | [码云](https://gitee.com/novel_dev_team/novel-front-web) -- 线上应用版:[GitHub](https://github.com/201206030/novel-plus) | [码云](https://gitee.com/novel_dev_team/novel-plus) | [演示站点](http://47.106.243.172:8888/) +- 前端项目(更新中):[GitHub](https://github.com/201206030/novel-front-web) + | [码云](https://gitee.com/novel_dev_team/novel-front-web) +- 线上应用版:[GitHub](https://github.com/201206030/novel-plus) | [码云](https://gitee.com/novel_dev_team/novel-plus) + | [演示站点](http://47.106.243.172:8888/) - 微服务版:[GitHub](https://github.com/201206030/novel-cloud) | [码云](https://gitee.com/novel_dev_team/novel-cloud) ## 开发环境 @@ -61,6 +70,7 @@ novel 是一套基于时下**最新** Java 技术栈 Spring Boot 3 + Vue 3 开 | Sonarqube | - | 代码质量控制 | https://www.sonarqube.org/ | - | **注:更多热门新技术待集成。** + ## 前端技术选型 | 技术 | 版本 | 说明 | 官网 | 学习 | @@ -70,7 +80,7 @@ novel 是一套基于时下**最新** Java 技术栈 Spring Boot 3 + Vue 3 开 | axios | 0.27.2 | 基于 promise 的网络请求库 | https://axios-http.com | [进入](https://axios-http.com/zh/docs/intro) | | element-plus | 2.2.0 | 基于 Vue 3,面向设计师和开发者的组件库 | https://element-plus.org | [进入](https://element-plus.org/zh-CN/guide/design.html) | -## 编码规范 +## 编码规范 - 规范方式:严格遵守阿里编码规约。 - 命名统一:简介最大程度上达到了见名知意。 @@ -183,97 +193,14 @@ io ![img](https://youdoc.github.io/img/novel/SwaggerUI.png) - ## 安装步骤 -此安装步骤的前提是需要保证上一节的开发环境可用。 +👉 [立即查看](https://docs.xxyopen.com/course/novel/#%E5%AE%89%E8%A3%85%E6%AD%A5%E9%AA%A4) -- 下载后端源码 +## 答疑 -```bash -git clone https://gitee.com/novel_dev_team/novel.git -``` +为了方便管理和查阅,安装过程中遇到任何问题请统一在指定评论区 👉 [立即前往](https://www.xxyopen.com/2022/07/18/os/novel.html) 留言 ,谢谢大家的配合! -- 数据库文件导入 - - 1. 新建数据库(建议 novel) - - 2. 解压后端源码`doc/sql/novel.sql.zip`压缩包,得到数据库结构文件`novel_struc.sql`和数据库小说数据文件`novel_data.sql` - - 3. 导入`novel_struct.sql`数据库结构文件 - - 4. 导入`novel_data.sql`数据库小说数据文件 - -- novel 后端服务安装 - - 1. 修改`src/resources/application.yml`配置文件中的数据源配置 - - ```yaml - spring: - datasource: - url: jdbc:mysql://localhost:3306/novel_test?useUnicode=true&characterEncoding=utf-8&useSSL=false&serverTimezone=Asia/Shanghai - username: root - password: test123456 - ``` - - 2. 修改`src/resources/application.yml` 和 `src/resources/redisson.yml` 配置文件中的`redis`连接配置 - - ```yaml - spring: - redis: - host: 127.0.0.1 - port: 6379 - password: 123456 - ``` - - ```yaml - singleServerConfig: - address: "redis://127.0.0.1:6379" - password: 123456 - ``` - - 3. 根据前后端的实际部署情况,修改`application.yml`中的跨域配置(默认情况可忽略此步骤) - - 4. 项目根目录下运行如下命令来启动后端服务(有安装 IDE 的可以导入源码到 IDE 中运行) - - ```bash - mvn spring-boot:run - ``` - 5. 接口文档访问地址:`http://server:port/swagger-ui/index.html` - - -- 下载前端前台门户系统源码 - -```bash -git clone https://gitee.com/novel_dev_team/novel-front-web.git -``` - -- novel-front-web 前端前台门户系统安装 - - 1. 根据前后端的实际部署情况,修改`.env.development`中的`VUE_APP_BASE_API_URL`属性(默认情况可忽略此步骤) - - 2. `yarn`安装 - - ```bash - npm install -g yarn - ``` - - 3. 项目根目录下运行如下命令来安装项目依赖 - - ```bash - yarn install - ``` - 4. 项目根目录下运行如下命令启动 - - ```bash - yarn serve - ``` - 5. 浏览器通过`http://localhost:1024`来访问 - -## 项目教程 - -[手把手教你从零开始开发上线一个生产级别的小说系统](https://docs.xxyopen.com/course/novel/3.html) - ## 公众号 - 关注公众号接收`项目`和`文档`的更新动态 @@ -295,4 +222,4 @@ git clone https://gitee.com/novel_dev_team/novel-front-web.git - 为用户提供更好的开发环境 - 一杯咖啡 -![mini-code](https://s1.ax1x.com/2020/10/31/BUQJwq.png) +![](https://s1.ax1x.com/2020/10/31/BUQJwq.png) \ No newline at end of file