# Shan_Koa_Server_Template

**Repository Path**: hashan/koa_server_template

## Basic Information

- **Project Name**: Shan_Koa_Server_Template
- **Description**: node + koa + mysql + log4js +npm 搭建的koa后端服务模板
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-03-27
- **Last Updated**: 2025-04-30

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 🚀 Shan Koa Serve Template


> 基于 Koa 的 Node.js 后端服务模板，集成数据库 ORM、日志、代码规范、Git 提交规范等常见功能，适合快速搭建企业级后端服务。



### ✅ To-Do 清单（按优先级排序）


| 编号 | 功能/任务                 | 状态          | 说明                             |
|------|--------------------------|----------------|----------------------------------|
| 1️⃣  | ✅ 完善统一返回数据格式   | 🔹进行中        | 所有接口应返回一致的 JSON 格式      |
| 2️⃣  | ✅ 新增微信登录功能       | ⚪待开发        | 支持小程序或公众号授权登录          |
| 3️⃣  | ✅ 普通用户登录功能       | ⚪待开发        | 账号密码登录、JWT 鉴权             |
| 4️⃣  | ✅ 创建用户表结构         | ⚪待开发        | 用户模型设计与数据库迁移           |
| 5️⃣  | ✅ 登录鉴权中间件         | ⚪待开发        | JWT Token 验证逻辑封装            |
| 6️⃣  | ✅ 封装工具类函数         | ⚪待开发        | 如加密、Token 生成等              |
| 7️⃣  | ✅ 异常处理模块完善       | ⚪待开发        | 统一错误码 + 中文提示              |
| 8️⃣  | ✅ 接口文档自动生成       | ⚪待开发        | 可选：Swagger                     |




## 📦 技术栈
```
- Koa: 框架
- MySQL: 数据库
- jsonwebtoken : token验证
- sequelize : ORM
- log4js: 日志
- Eslint: 代码规范
- commitizen: git提交规范
- Prettier: 代码格式化

```

## 📁 目录结构
```
📂 config/: 存放配置文件
📂 db/: 数据库文件
📂 controllers/: 存放控制器文件，处理业务逻辑
📂 middlewares/: 存放自定义中间件
📂 models/: 存放数据库模型
📂 services/: 存放服务层文件，封装与数据库交互的逻辑
📂 exception/: 存放错误Code
📂 utils/: 存放工具类
📄 app.js: 入口文件
📄 server.js:使用koa封装服务文件
📄 .env: 环境变量文件
📄 package.json: 项目依赖包信息
📄 README.md: 项目说明文件
📄 .gitignore: git忽略文件
📄 .eslintrc.js: eslint配置文件
📄 .prettierrc.js: prettier配置文件
📄 .cz-config.js: commitizen配置文件
📄 .commitlintrc.cjs: commitlint配置文件
```


## ⚡ 快速开始
```bash
pnpm install  // 安装依赖
pnpm start  // 启动服务
```