README.md 1.5 KB
Newer Older
yubinCloud's avatar
yubinCloud 已提交
1
# Fairy Wiki —— 知识库系统
yubinCloud's avatar
yubinCloud 已提交
2

yubinCloud's avatar
yubinCloud 已提交
3 4 5 6
![](https://img.shields.io/badge/license-MIT-000000.svg) ![](https://img.shields.io/badge/language-Java-orange.svg) ![](https://img.shields.io/badge/language-TypeScript-green.svg)

![Fairy2_small](https://gitee.com/yubinCloud/my-imgs-repo/raw/main/img/Fairy2_small.png)

yubinCloud's avatar
yubinCloud 已提交
7
可以在云端存储电子书、文档的知识库 Wiki 系统,一个由 **Spring Boot** + **Vue3** 搭建的全栈项目:
yubinCloud's avatar
yubinCloud 已提交
8

yubinCloud's avatar
yubinCloud 已提交
9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60
+ 前端 Vue CLI & Ant Design Vue 项目搭建
+ 后端 Spring Boot 搭建

## 界面设计

![FairyWikiDemo](https://gitee.com/yubinCloud/my-imgs-repo/raw/main/img/FairyWikiDemo.jpg)

+ 用户管理
+ 电子书管理
+ 文档管理
+ 分类管理
+ 富文本框的集成
+ 图形统计报表展示
+ ....

## 关键技术点

+ **axios** 解决前后端分离架构的通信问题
+ **AOP** 日志记录
+ **RocketMQ、WebSocket** 异步化实现消息通知
+ **ECharts** 用于数据统计展示
+ 定时任务设计
+ **Redis** 存储用户 token 和登陆校验
+ **Ant Design for Vue** 用于构建前端界面
+ 多环境配置文件分别用于开发和生产
+ **统一异常处理**
+ **拦截器****过滤器**
+ ......

## 启动方式

需要分别启动前端和后端

+ 后端启动方式:

  + 使用 IDEA 打开后,安装 **lombok** 插件
  + 启动 Redis
  + 启动 RocketMQ
  + 以 Maven 方式运行该 Spring Boot 项目

+ 前端启动方式:

  + 在 /web 子目录下,运行一下命令:

  ```bash
  $ npm install
  ...
  $ npm start serve-dev
  ...
  ```