# node-project-template

**Repository Path**: liu-yi-chen/node-project-template

## Basic Information

- **Project Name**: node-project-template
- **Description**: Node.js 服务端快速开发模板。基于 TypeScript，结合了面向对象与函数式两种编程范式，简单、易用、可靠的服务端研发体验。
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 1
- **Created**: 2024-06-07
- **Last Updated**: 2024-06-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# my_midway_project

## 快速入门

<!-- 在此次添加使用文档 -->

如需进一步了解，参见 [midway 文档][midway]。

### 本地开发

```bash
$ npm i
$ npm run dev
$ open http://localhost:7001/
```

### 部署

```bash
$ npm start
```

### 内置指令

- 使用 `npm run lint` 来做代码风格检查。
- 使用 `npm test` 来执行单元测试。


[midway]: https://midwayjs.org

## 项目开发规范

### 代码提交规范

`git commit -m [type]: [description]`  注意: 冒号后面有一个空格

```bash
- fix: 修改bug [常用]
- feat: 新功能,新特性 [常用]
- meege: 合并分支 [常用]
- style: 代码格式修改, 注意不是css修改(例如分号修改) [常用]
- refactor: 代码重构(重构,在不影响代码内部行为,功能下的代码修改) [常用]
- build: 影响项目构建或依赖项修改
- delete: 删除没有用到的包或第三方库
- update: 更新包或第三方库
- tag: 版本号更新或修改
- revert: 恢复上一次提交
- ci: 持续集成相关文件修改,如dockerfile等
- chore: 其他修改(不在上述类型中的修改)
- workflow: 工作流相关文件修改
- docs: 文档修改
- test: 测试用例新增和修改
```

### 分支管理规范

```bash
1. 开发新的功能,从master分支切新的以feature为前缀的功能分支出来开发
2. 开发功能分支例子: feature/xxxx
3. 功能分支开发完成后,在提测前,往develop分支提merge request给对应的人进行code review
4. code review 通过后,用develop分支发布测试环境
5. 测试通过后,需上线的代码,由feature分支合并到上线的release分支
6. releasee分支发布uat环境,产品和业务验收通过后,才允许上线
7. release分支上线完成后合并上线release分支回master分支
```