# Node Server Base on Koa2 TypeScript

**Repository Path**: wudongo/node-server-base-on-koa2-type-script

## Basic Information

- **Project Name**: Node Server Base on Koa2 TypeScript
- **Description**: 技术栈为Koa2、TypeScript、Sequelize 等
带有用户登录、注册验证的 Node Server 基础模板
- **Primary Language**: TypeScript
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2023-03-25
- **Last Updated**: 2024-04-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: TypeScript, Sequelize, Koa, Nodejs, Server

## README

# Node Server Template
<h2 align="left">
  <a href="https://gitee.com/biaovorg/project-template/tree/vue"><img src="https://img.shields.io/badge/version-v1.0.0-g" /></a>
</h2>  

## 项目介绍
技术栈为Koa2、TypeScript、Sequelize 等  

基础模板支持:  
- 用户登录、注册验证接口
- CRUD 抽象简化, 编写接口方便容易
- 报文格式一致性处理
- 异常捕获能力
- Token 验证中间件
- 其它基础能力  

## 项目优势
- Controller、Service、Model 分层

- Database 使用 mysql 为样例

- 定义了装饰器为 CRUD 基础接口进行了统一处理

- 用中间件做了这些事情：
  - 传递 Service、Model 关键字, 可于 Route 中配置, 无需引入
  - 打印 API 日志
  - 权限验证

## 使用方式

### 依赖安装
```Javascript
yarn
```
### 开发环境调试
```Javascript
yarn dev
```
### 生产环境启动
```Javascript
npm i -s pm2
pm2 start index.js --name 'server'
```