# koa2-ts-template

**Repository Path**: lhdhtrc/koa2-ts-template

## Basic Information

- **Project Name**: koa2-ts-template
- **Description**: 基于koa2+ts的项目模板
- **Primary Language**: TypeScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 2
- **Created**: 2022-08-12
- **Last Updated**: 2024-10-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# koa2-ts-template

#### 介绍
基于koa2+ts的项目模板

#### 软件架构
nodeJS+Mysql+Redis

#### 特性

- 高扩展性
- 支持Typescript
- 支持RESTful接口方式
- 支持别名
- 支持多版本路由
  - 按照规范命名路由版本 vxx
  - 多版本路由控制还没有实现，预计在下个小版本中更新
- 支持路由自动注册
  - 按照规范进行命名路由文件， xxx.routes.ts
- 支持日志记录
  - 错误日志 ctx.app.emit('error', error, ctx);
- 支持错误捕获及处理
- 支持mysql（sequelize）
  - 支持一键更新数据模型
  - 数据模型统一存放 server/model/mysql/xxx.model.ts
  - 支持多数据库并存
- 支持redis（ioredis）
  - 支持多数据库并存
- 支持mongodb（mongoose）
  - 数据模型统一存放 server/model/mongodb/xxx.mongo.ts
  - 支持多数据库并存
- 支持邮件服务
- 支持art-template
  - 所有的模板文件应当存放于 server/template/xxx.art
- 支持图形验证码（svg-capture）
- 支持对数据加密（crypto-js）


#### 安装教程

1.  git clone git@gitee.com:Arell/koa2-ts-template.git
2.  npm install
3.  npm run serve

#### 使用说明

1. 环境配置

   1. 全局环境

      ```bash
      # 全局环境 production or development
      # NODE_ENV = production
      NODE_ENV = development
      
      # 生产环境地址(需配置nginx代理)
      PRODUCTION_ADDRESS = https://api.lhdht.cn/demo
      ```

   2. 开发环境

      ```bash
      # 开发环境
      
      # 服务端口
      SERVER_PORT = 3700
      
      # mysql配置
      MYSQL_HOST=172.28.109.160
      MYSQL_PORT=3756
      MYSQL_USERNAME=root
      MYSQL_PASSWORD=123456789
      
      # redis配置
      REDIS_HOST=172.28.109.160
      REDIS_PORT=3647
      REDIS_FAMILY=4
      REDIS_PASSWORD=123456789
      
      # mongodb配置
      MONGO_HOST=172.28.109.160
      MONGO_PORT=3648
      MONGO_USERNAME=root
      MONGO_PASSWORD=123456789
      
      # 配置邮箱服务
      EMAIL_HOST=smtp.163.com
      EMAIL_PORT=25
      #true for 465, false for other ports
      EMAIL_SECURE=false
      EMAIL_AUTH_FROM=demo
      EMAIL_AUTH_USER=demo@163.com
      EMAIL_AUTH_PASS=UUGKMPMOFEOHDPOHFF
      ```

   3. 生产环境

      ```bash
      # 生产环境
      
      # 服务端口
      SERVER_PORT = 37000
      
      # mysql配置
      MYSQL_HOST=172.28.109.160
      MYSQL_PORT=3756
      MYSQL_USERNAME=root
      MYSQL_PASSWORD=123456789
      
      # redis配置
      REDIS_HOST=172.28.109.160
      REDIS_PORT=3647
      REDIS_FAMILY=4
      REDIS_PASSWORD=123456789
      
      # mongodb配置
      MONGO_HOST=172.28.109.160
      MONGO_PORT=3648
      MONGO_USERNAME=root
      MONGO_PASSWORD=123456789
      
      # 配置邮箱服务
      EMAIL_HOST=smtp.163.com
      EMAIL_PORT=25
      #true for 465, false for other ports
      EMAIL_SECURE=false
      EMAIL_AUTH_FROM=demo
      EMAIL_AUTH_USER=demo@163.com
      EMAIL_AUTH_PASS=UUGKMPMOFEOHDPOHFF
      ```

2. xxxx

3. xxxx

#### 参与贡献

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