# onlyBlog

**Repository Path**: wr_lx/onlyBlog

## Basic Information

- **Project Name**: onlyBlog
- **Description**: 基于koa和sequelize 开发的result api 后台 ，使用bcryptjs对密码进行加密，并进行了权限控制，分配权限，根据权限进行路由拦截。 使用sequelize对数据库进行操作，jwt对token进行封装，log4js进行日志监控，https访问，文件上传，跨域


- **Primary Language**: NodeJS
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2024-04-04
- **Last Updated**: 2024-06-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Nodejs, Koa, 权限, JWT

## README

# onlyBlog
使用node.js技术，基于koa和sequelize开发的result api后台 ，使用bcryptjs对密码进行加密，并进行了权限控制，分配权限，根据权限进行路由拦截。

使用sequelize对数据库进行操作，jwt对token进行封装，log4js进行日志监控，https访问，文件上传，跨域，使用pm2进行进程守护，docker部署，使用cluster集群提高服务器效率，使用限流中间件，提高并发处理能力。

Koa 框架做服务端 API 接口，只做了简单的基础，其余内容可以根据代码进行扩展

访问地址 https://ad.gqgwr.cn 账号是lx 密码123456

后台管理系统地址：https://github.com/LX-GQG/onlyBlogAdmin

## 1.1 项目功能
- 文章管理（包含文章评论，点赞等）
- 标签管理
- 用户管理
- 权限管理
    - 用户管理
    - 用户组管理
- 埋点统计 （是我个人网站的埋点数据，可以查看我网站的访问量，访问人数，访问设备，访问地区，访问来源，访问页面等）
  - 埋点数据
  - 埋点图表

## 1.2 项目结构
```
├─app.js (入口文件)
├─package-lock.json
├─package.json
├─README.md
├─utils (工具库)
|   ├─auth.js (登录权限的中间件)
|   ├─log4.js (封装日志)
|   ├─token.js (验证token jwt)
|   └─utils.js (封装的函数，方法库)
├─ssl(存放https证书)
├─router (路由)
|   ├─index.js (封装路由) 
|   └─router.js (路由列表)
├─public (上传文件)
├─models (业务逻辑映射成数据模型)
├─middleware (中间件)
|     ├─error.js (封装统一返回错误)
|     ├─index.js (封装统一)
|     └─response.js (封装统一返回内容)
├─logs (日志记录)
├─controllers (控制层，数据处理)
├─config (配置)
|   ├─config.js (数据库配置)
|   ├─db.js (连接数据库)
|   ├─dbContent.js (封装数据库方法)
|   └─secret.js (密钥)
├─Dockerfile.js (docker部署文件)
```

## 1.4 启动项目
```
# 进入项目根目录

cd onlyBlog

# 安装依赖包

npm install 或者 yarn install

# 启动 Node.js Koa2 项目

npm run dev 或者 yarn dev
```

## 1.5 使用Docker部署
```
# 进入项目根目录

cd onlyBlog
# 构建镜像
docker build -t onlyblog .
# 启动容器

docker run -d -p 3658:3658 onlyblog

# 确认是否成功
docker ps -a
```

api接口文档地址：https://console-docs.apipost.cn/preview/6aabac7f4427a4ca/8a7c5e8c98f2b42a
这里的接口可以使用 api.gqgwr.cn 直接调用

本项目有权限控制，需登录，请求头上需要Authorization: Bearer + token才可以访问，Bearer和token需要用空格隔开。
超级管理员拥有全部权限 
账号：admin
密码：123456

端口号设置在根目录下的app.js文件中
默认端口为3658，
即可通过 https://localhost:3658/admin/xxx 调用后台接口(需要token，以及根据token的权限)
https://localhost:3658/api/xxx 调用前台接口(目前只有登录接口，文章接口，后续会继续完善)