# 快速开始

# 项目简介

novel 是一套基于时下最新 Java 技术栈 Spring Boot 3 + Vue 3 开发的前后端分离的学习型小说项目，配备详细的项目开发文档手把手教你从零开始开发上线一个生产级别的 Java 系统，由小说门户系统、作家后台管理系统、平台后台管理系统等多个子系统构成。包括小说推荐、作品检索、小说排行榜、小说阅读、小说评论、会员中心、作家专区、充值订阅、新闻发布等功能。

# 项目地址

单体架构后端项目：GitHub (opens new window) 码云 (opens new window) 文档 (opens new window)
微服务架构后端项目：GitHub (opens new window) 码云 (opens new window) 文档 (opens new window)
前端项目：GitHub (opens new window) 码云 (opens new window)
线上应用版：GitHub (opens new window) 码云 (opens new window)

# 开发环境

MySQL 8.0
Redis 7.0
Elasticsearch 8.2.0（可选）
RabbitMQ 3.10.2（可选）
XXL-JOB 2.3.1（可选）
JDK 17
Maven 3.8
IntelliJ IDEA 2021.3（可选）
Node 16.14

注：Elasticsearch、RabbitMQ 和 XXL-JOB 默认关闭，可通过 application.yml 配置文件中相应的enable配置属性开启。

PS：觉得手动安装开发环境比较麻烦的同学可以使用 Docker Compose 一键安装开发环境

# 安装步骤

此安装步骤的前提是需要保证上一节的开发环境可用。

下载后端源码

git clone https://gitee.com/novel_dev_team/novel.git

数据库文件导入
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配置文件中的数据源配置
```
spring:
    datasource:
        url: jdbc:mysql://localhost:3306/novel_test?useUnicode=true&characterEncoding=utf-8&useSSL=false&serverTimezone=Asia/Shanghai
        username: root
        password: test123456
```
1. 修改src/resources/application.yml 配置文件中的redis连接配置
```
spring:
    data:
        # Redis 配置
        redis:
        host: 127.0.0.1
        port: 6379
        password: 123456
```
1. 根据前后端的实际部署情况，修改application.yml中的跨域配置（默认情况可忽略此步骤）
2. 项目根目录下运行如下命令来启动后端服务（有安装 IDE 的可以导入源码到 IDE 中运行）
```
mvn spring-boot:run
```
1. 接口文档访问地址：http://server:port/swagger-ui/index.html
下载前端前台门户系统源码

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安装
```
npm install -g yarn
```
1. 项目根目录下运行如下命令来安装项目依赖
```
yarn install
```
1. 项目根目录下运行如下命令启动
```
yarn serve
```
1. 浏览器通过http://localhost:1024来访问

技术架构 →