# Koa2_rapid_dev

**Repository Path**: gaogao520/koa2_rapid_dev

## Basic Information

- **Project Name**: Koa2_rapid_dev
- **Description**: 使用koa2集成一些常用中间件，达到快速开发的目的。
- **Primary Language**: JavaScript
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-12-03
- **Last Updated**: 2025-04-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Koa2_rapid_dev

#### 介绍
使用koa2集成一些常用中间件，达到快速开发的目的。

#### 软件架构
软件架构说明
1. CRUD


#### 安装教程

1.  npm install
2.  npm install -g nodemon #全局安装 dev环境热更新
3.  npm run dev
4.  npm run apidoc #生成api文档(routes下未写注解不会生成文档)
5.  npm run sydb #同步数据库


#### 实现的功能
1.  接口的响应统一 & api文档 routes\config.js & npm run apidoc
2.  entity(实体) & 路由(控制器)自动加载 config\synchronous.js & routes\index.js & npm run sydb
3.  实现简单的ICO routes\ico.js
4.  jwt 使用crypto混淆，每次重新启动服务重新混淆 config/jwt.js & config/crypto.js
5.  错误自定义 error/jwt.js

#### 依赖说明

1. **"date-fns": "^2.30.0"** - 一个现代JavaScript日期实用程序库。
2. **"debug": "^4.1.1"** - 一个小型的调试实用程序，用于Node.js。
3. **"jsonwebtoken": "^9.0.2"** - 一个用于签署、验证和解析JSON Web Tokens (JWTs)的库。
4. **"koa": "^2.7.0"** - 一个优雅的Node.js web框架，旨在创建易于阅读和编写的web应用程序。
5. **"koa-body": "^6.0.1"** - Koa的中间件，用于解析请求体。
6. **"koa-bodyparser": "^4.2.1"** - Koa的中间件，解析传入的请求数据。
7. **"koa-convert": "^1.2.0"** - 用于将其他中间件转换为Koa中间件的实用程序。
8. **"koa-json": "^2.0.2"** - 一个Koa中间件，用于将响应对象转换为JSON格式。
9. **"koa-jwt": "^4.0.4"** - JWT认证中间件，用于Koa。
10. **"koa-logger": "^3.2.0"** - 为Koa提供日志功能的中间件。
11. **"koa-onerror": "^4.1.0"** - 错误处理中间件，用于Koa。
12. **"koa-router": "^7.4.0"** - 用于Koa的路由器中间件，允许你定义路由和处理程序。
13. **"koa-static": "^5.0.0"** - 为Koa提供静态文件服务的中间件。
14. **"koa-views": "^6.2.0"** - 用于Koa的视图渲染中间件。
15. **"lodash": "^4.17.21"** - 一个JavaScript实用程序库，提供了一套完整的实用程序函数。
16. **"mysql2": "^3.6.5"** - 一个用于Node.js的MySQL驱动程序，允许你连接到MySQL数据库。
17. **"pug": "^2.0.3"** - 一个流行的模板引擎，用于Node.js。
18. **"require-all": "^3.0.0"** - 一个简单的工具，用于从目录中加载所有模块。
19. **"sequelize": "^6.35.1"** - 一个基于Promise的Node.js ORM（对象关系映射器），支持PostgreSQL、MySQL、MariaDB、SQLite和Microsoft SQL Server。


#### 参与贡献

1.  Fork 本仓库
2.  新建 Feat_xxx 分支
3.  提交代码
4.  新建 Pull Request


#### 后续开发
1.  定时任务的开发
2.  上传文件使用ftp/sanba储存
3.  对接redis/mongodb
4.  对接rabbitmq/kafka