# node-axle

**Repository Path**: liushp1/node-axle

## Basic Information

- **Project Name**: node-axle
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-06-24
- **Last Updated**: 2025-06-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

express-axle
---
## 简介
express-axle是一个基于express框架封装的面向对象业务框架，并集成websocket通讯功能，使开发人员直接注重于业务开发
。数据库采用国产DM8
> 项目采用pkg进行打包交付，避免源代码泄露 

该框架在设计和使用上，通过集成三方中间件实现功能的扩展

## 设计原则
* 约定大于配置
* 配置业务分离

## 应用目录
```bash
.
├── README.md               // 框架介绍
├── configMap.json          // 配置文件
├── dist                    // es6编译成commonjs的文件目录
├── lib                     // 打包后二进制文件存放位置
├── package-lock.json
├── package.json
├── public
├── src                     // 源代码
│   ├── app.js
│   ├── controllers
│   ├── middleware
│   ├── models
│   ├── routers
│   ├── services
│   ├── utils
│   ├── websocket
│   └── websocket.js
└── test
```
> configMap.json为配置文件；<br/>
> dist为es6规范转为commonjs规范之后的源代码，通过执行命令自动创建<br/>
> lib目录为pkg打包后的文件，可直接运行；通过打包命令，会自动创建<br/>
> src为源代码

##### 安装
`npm install`
##### 普通启动/热启动/pm2热启动/babel编译/babel编译后启动
`npm start dev  /  npm run start:dev  /  pm2 start app.js --watch / npm start compile / npm start dev_dist `

###### pkg打包
```shell
1、主服务打包： 修改package.json的bin为"./dist/app.js"， 并更正pkg下script内容为"dev_dist"
2、websocket服务：修改package.json的bin为"./dist/websocket.js"， 并更正pkg下script内容为"dev_socket_dist"
分别通过npm run build 进行打包

```