koa-sail-ts

README English Version

关于

基于koa(2.x)框架的种子工程, 采用typescript编写

使用方法

快速开始(开发环境)

yarn
# use ts-node
yarn start

测试与检查

# 单元测试 first run `yarn start`
yarn test
# 代码规范检查
yarn run eslint:check
# 代码规范修复
yarn run eslint:fix

配置

参考config-document

构建

yarn run build

用于生产环境

# if not pm2, please run `yarn global add pm2`
# first run `yarn run build`
yarn run prod

搭配docker

# 生成docker镜像
docker build -t <image-name>:<tag> .

For CI command

# this is an example
#!/bin/bash
echo 'start...'
docker stop koa-sail-ts
docker rm koa-sail-ts
docker rmi koa-sail-ts:0.1.0
docker build -t koa-sail-ts:0.1.0 .
docker run --name koa-sail-ts -p 8183:8181 -v /home/docker/koa-sail-ts/logs:/usr/src/app/logs -d koa-sail-ts:0.1.0
echo 'finished'
exit 0

功能与特点

• 采用typescript
• 采用pm2作为nodejs进程管理工具
• 登录与api鉴权(powered by passportjs and jwt)
• 提供api参数校验中间件 validator-document
• websocket支持(powered by ws)
• 日志记录(powered by log4js)
• 单元测试(powered by mocha)
• 支持docker部署

致谢

本项目的诞生与发展离不开koa、log4js、jsonwebtoken、typescript等项目,具体见package.json的dependencies与devDependencies。

本项目最初由koa-generator生成，最初采用js编写，0.4.0之后切换到typescript。虽然随着项目的发展，已与最初相差甚大，但koa-generator对于本项目的起步十分重要。

如果你希望采用class类设计api，请参考本项目的0.8.x【其实现参考了如何使用koa2+es6/7打造高质量Restful API】。

如果你更喜欢express风格的api，请参考本项目的0.6.x