mirror of
https://gitee.com/bookshelfplus/bookshelfplus
synced 2025-09-21 01:10:39 +08:00
完善README.md
This commit is contained in:
7
.gitignore
vendored
7
.gitignore
vendored
@@ -14,7 +14,8 @@ package-lock.json
|
||||
# 排除所有调试产生的log文件
|
||||
*.log
|
||||
|
||||
.vs/*
|
||||
# 排除idea项目 iml 文件
|
||||
bookshelfplus.iml
|
||||
|
||||
*.njsproj.user
|
||||
obj/*
|
||||
# TODO文件
|
||||
TODO*
|
60
README.md
60
README.md
@@ -1,21 +1,61 @@
|
||||
# 计算机类电子书网站开源项目
|
||||
# 书栖网 网站开源项目
|
||||
|
||||
> 如需获取计算机类电子书,请访问https://books.only4.work/ ,或前往Git仓库👉([GitHub](https://github.com/only-4/computer-related-books)、[Gitee](https://gitee.com/only4/computer-related-books))
|
||||
> 如需获取计算机类电子书,请访问https://bookshelf.plus/ ,或前往Git仓库👉([GitHub](https://github.com/only-4/computer-related-books)、[Gitee](https://gitee.com/only4/computer-related-books))
|
||||
|
||||
当前项目为 https://books.only4.work 网站源代码,你也可以通过这个项目搭建一个属于自己的电子书分享与管理平台。
|
||||
当前项目为 https://bookshelf.plus 网站源代码,你也可以通过这个项目搭建一个属于自己的电子书分享与管理平台。
|
||||
|
||||
[接口文档](api.md)
|
||||
|
||||
## 前端
|
||||
|
||||
开发使用 nodemon,代码变动后自动重启。
|
||||
|
||||
使用以下代码安装 nodemon
|
||||
## 开始使用
|
||||
|
||||
```
|
||||
> 所需环境:Java JDK 8+,Maven,MySQL 5.7+,nodejs等
|
||||
|
||||
### 安装环境
|
||||
|
||||
```bash
|
||||
# 安装 nodejs
|
||||
# 官方网站:https://nodejs.org/zh-cn/
|
||||
# 下载地址:https://nodejs.org/dist/v16.14.0/node-v16.14.0-x64.msi
|
||||
|
||||
# 安装 JDK 8
|
||||
|
||||
# 安装 Maven
|
||||
|
||||
# 安装 MySQL 5.7
|
||||
|
||||
# 导入数据库SQL脚本
|
||||
|
||||
# nodemon(可选)
|
||||
# 开发使用 nodemon,代码变动后自动重启。
|
||||
# 使用以下代码安装 nodemon
|
||||
npm i nodemon -g
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
nginx启动目录不能包含中文
|
||||
|
||||
## 项目架构
|
||||
|
||||
> 项目前后端分离开发,使用了不同的技术,通过nginx进行反向代理
|
||||
|
||||
**前端**采用`nodejs`开发,使用`axios`、`jQuery`等组件。
|
||||
|
||||
**后端**采用`SpringBoot`开发,数据库连接使用`mybatis`、`alibaba druid`,接口文档生成使用`swagger2`,参数验证采用`hibernate`,日期时间处理使用`joda-time`工具类,同时还使用了`lombok`简化代码。
|
||||
|
||||
**数据库**采用`MySQL`,会话缓存采用`redis`。
|
||||
|
||||
**反向代理**使用`nginx`。
|
||||
|
||||
**对象存储**对接腾讯云COS存储(`cos_api`)。
|
||||
|
||||
|
||||
|
||||
## 开发工具
|
||||
|
||||
前端:VS Code,后端:idea,数据库:MySQL
|
||||
|
||||
|
||||
|
||||
## 注意事项
|
||||
|
||||
- nginx启动目录不能包含中文,否则无法启动
|
Reference in New Issue
Block a user