Skip to content

yubingcen/koa-ts-yu

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

45 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Koa2-TS

基于koa2的自己的建站基础模板,使用TypeScript,目前功能简单,处于前期开发状态。

建议环境

  • Koa2
  • TypeScript
  • NodeJS
  • MongoDB
  • Redis

安装

  • 安装依赖

yarn

  • 生成修改配置

cp ./src/config/configs.ts.example ./src/config/configs.ts

  • 本地开发

yarn run server

安装注意:

缩略图生成采用 gmImageMagick

  • ImageMagick安装

sudo apt-get install imagemagick

  • ImageMagick 在 windows 平台中使用Nodejs中的gm模块处理图片时,如果不安装、安装imageGagick.exe版本不对或安装选项不对时都会报类似于“{ [Error: Command failed: aaЧaaaa ] code: 4, signal: null }”的错。 7.0版本安装时必须勾选"Install legacy utilities(e.g. convert)"选项,否则会报错。

目录结构

.
├──logs                       // 生成日志文件
├──src
│    ├── models                   // model层 处理数据
│    ├── config                   // 配置文件
│    ├── common                   // 公用的
│    ├── utils                    // 工具
│    ├── controller               // 控制层
│    ├── routes                   // 路由
│    ├── index.ts                 // 入口文件
├── .gitignore               //git忽略文件
├── package.json             // 项目配置文件

计划功能

  • 用户管理
    • 注册
    • 登陆
    • 用户权限
  • 权限管理
  • 邮件模板
    • 修改密码(邮件发送)
  • 权限管理
  • 文件管理
    • 文件存储
    • 缩略图生成
  • 日志管理
    • 日志生成
    • 报错管理
  • 文章管理
    • 文章模块
    • 文章编辑
  • 功能开关
    • 基础功能模块

计划项目优化

  • webpack集成
  • 代码风格限制/重写
  • 增加biz层
  • 接口文档生成
  • 接口测试

About

This is my typescript koa2 project example.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published