WMS_MAIN/README.md
2026-03-22 01:19:55 +08:00

96 lines
2.9 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 奇门WMS(qimen-wms)
基于 Egg.js 的仓储管理系统(WMS),支持多快递平台对接、订单管理、打印、权限、配置等功能,适合中小型电商、仓储企业二次开发。
---
## 目录结构
```
├── app/ # 业务主目录(controller, service, model, router等)
│ ├── controller/ # 控制器(API、模板、认证等)
│ ├── service/ # 业务服务(含快手/PolyAPI、打印、系统等)
│ ├── model/ # Sequelize模型
│ ├── dict/ # 业务字典
│ ├── view/ # 前端模板
│ └── router.js # 路由定义
├── config/ # 配置(含poloapi、redis、数据库等)
├── database/ # 数据库迁移与配置
├── public/ # 静态资源
├── logs/ # 日志
├── run/ # 运行时/元数据
├── test/ # 单元测试
├── package.json # 依赖与脚本
├── app.js # 应用入口
└── README.md # 项目说明
```
## 主要依赖
- egg.js 3.x
- egg-sequelize、egg-mysql、egg-redis
- egg-jwt、egg-cors、egg-view-ejs
- fast-xml-parser、cos-js-sdk-v5、qiniu-js、soap
## 快速开始
```bash
npm install
npm run dev
# 访问 http://localhost:6060/
```
## 启动与部署
开发环境:
```bash
npm run dev
```
生产环境:
```bash
npm start
npm stop
```
## 常用 npm 脚本
- `npm run lint` 代码风格检查
- `npm test` 单元测试
- `npm run dev` 本地开发
- `npm start` 启动生产服务
## 配置说明
- 主要配置文件在 `config/` 目录下(如 poloapi.js、config.default.js、config.local.js)
- 数据库、Redis、快手/PolyAPI等均可在对应文件中调整
## 主要功能模块
- 多快递平台对接(快手/PolyAPI等,详见 config/poloapi.js)
- 订单管理、打印、仓库/门店管理
- 权限与角色、员工管理
- API接口(RESTful风格,详见 app/router.js)
- 日志、配置、业务字典
## 路由示例
- `GET /` 首页/健康检查
- `POST /qimen` 奇门接口
- `POST /api/warehouse` 仓库API
- `POST /api/store` 门店API
- `POST /api/v1` 旧版API
- `POST /api/v2` 新版API
- `GET /template/xml/:id` 获取打印模板
- `GET|POST /auth/printSetting/:code` 打印台设置
## 开发建议
- 业务字典已全局挂载(见 app.js)
- 所有服务建议继承 Egg Service,便于单元测试
- 配置、密钥等敏感信息请勿提交到仓库
## 常见问题
- 启动端口默认 6060,可在 `package.json` 或 `config` 中调整
- 数据库/Redis 连接失败请检查 config.local.js
- 打印、快递API对接请参考 `app/service/systems/polo_api.js` 和 `config/poloapi.js`
---
如需二次开发或遇到问题,欢迎提 issue 或联系维护者。
[Egg.js 官方文档](https://eggjs.org)