# my_cli_express

**Repository Path**: tomatogitee/my_cli_express

## Basic Information

- **Project Name**: my_cli_express
- **Description**: 基于 Express、Nodejs、Typescript 的后台服务器脚手架
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-15
- **Last Updated**: 2020-12-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 基于 Express、Nodejs、Typescript 的后台服务器脚手架

## 项目工具

- 本脚手架使用了 webpack 进行打包
- 使用 babel 转换器将高阶语法转换为 ES5 代码
- 使用 prettier 进行代码可视化
- 使用 eslint 进行代码规则校验
- 使用 editorconfig 进行代码风格一致化规范

## 使用的中间件

- 本脚手架集成了 morgan 调试信息打印中间件
- 集成了 body-parser 中间件
- 集成了 cors 跨域资源共享中间件

## 使用方法

### 1. 克隆项目

```git
git clone https://gitee.com/tomatogitee/my_cli_express.git
```

### 2. 初始化项目

- YARN（推荐）

```npm
yarn
```

- NPM

```npm
npm install
```

### 3. 运行项目

- YARN（推荐）

```npm
yarn dev
&&
nodemon build/index.js // 或者进行下一步配置，使用vscode进行调试
```

- NPM

```npm
npm run dev
&&
nodemon build/index.js / 或者进行下一步配置，使用vscode进行调试
```

#### Tip： nodemon 需要提前全局安装好

```npm
npm install -g nodemon
```

### 4. 调试配置（可选，但是强烈建议）

- 配置 launch.json

```json
// .vscode/launch.json
{
  // 使用 IntelliSense 了解相关属性。
  // 悬停以查看现有属性的描述。
  // 欲了解更多信息，请访问: https://go.microsoft.com/fwlink/?linkid=830387
  "version": "0.2.0",
  "configurations": [
    {
      "type": "node",
      "request": "launch",
      "name": "启动程序",
      // 被调试代码的入口
      "program": "${workspaceFolder}/build/index.js",
      // 调试时跳过的文件夹
      "skipFiles": [
        "${workspaceFolder}/node_modules",
        "${workspaceFolder}/webpack"
      ],
      "cwd": "${workspaceFolder}",
      // 调试协议
      "protocol": "inspector",
      // 运行的工具
      "runtimeExecutable": "nodemon",
      // 中止Node.js后重启会话
      "restart": true,
      // 在调试控制台输出
      "console": "integratedTerminal",
      // 打开调试控制台
      "internalConsoleOptions": "openOnFirstSessionStart"
    }
  ]
}
```

- 使用方法修改

1. YARN（推荐）

```npm
yarn dev
&&
运行F5调试
```

2. NPM

```npm
npm run dev
&&
运行F5调试
```