# doc-node

**Repository Path**: my-doc/doc-node

## Basic Information

- **Project Name**: doc-node
- **Description**: 对应 doc-web 项目，新个人文档项目的express项目，无数据库，修改的文档会写入到doc-md项目，提交并推送
- **Primary Language**: NodeJS
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-01-18
- **Last Updated**: 2023-01-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# node 服务端接口项目

- 开发者使用的 node 版本：v16.14.2

**1. 安装依赖**

```sh
npm install
```

**2. 启动开发环境**

```sh
npm run dev
```

启动完成后，可在访问本地 http://localhost:4010 来访问此接口服务。

**3. 文档保存位置和说明**

需要自己创建远程仓库，github、gitee、gitlab均可。

拿到项目git地址克隆到本地，保持项目文件夹和此node项目在同一目录下。

文件夹名需要是「doc-md」，也可以是其他名称，但需要在文件「src/config/index.js」中对应修改文件夹名称，让此node项目能找到。

**注意：**

前台页面修改文档后，node会对应的修改文档文件夹内部文件，然后自动提交、推送，推送使用的指令为：`git push origin master`，所以需要保持远程仓库名称为 origin，分支为 master。


**4. 使用pm2启动项目**

pm2官网文档：[https://pm2.keymetrics.io/docs/usage/quick-start/](https://pm2.keymetrics.io/docs/usage/quick-start/)。

```sh
# 全局安装 pm2
npm install -g pm2
```

进度到此目录，执行以下指令启动 pm2：
```sh
pm2 -n 'doc-node' start npm -- start
```

服务已启动，pm2 常用指令：
| 功能                                              | 指令                                             | 备注                                          |
| ------------------------------------------------- | ------------------------------------------------ | --------------------------------------------- |
| 初次启动                                          | pm2 start <服务文件路径> -n '<服务名称>'         | -n 可以使用 --name 替换，意思为给服务设置别名 |
| 初次启动 npm 指令(初次执行需要再项目文件夹下执行) | pm2 -n '<服务名称>' start npm -- run start       | pm2 -n '服务1' start npm -- run start         |
| 再次启动                                          | pm2 start <服务ID>                               |                                               |
| 重启某个服务                                      | pm2 restart <服务文件路径 &#124; 服务ID>         |                                               |
| 重启所有服务                                      | pm2 restart all                                  |                                               |
| 重载某个服务                                      | pm2 reload <服务文件路径 &#124; 服务ID>          |                                               |
| 重载所有服务                                      | pm2 reload all                                   |                                               |
| 停止某个服务                                      | pm2 stop <服务文件路径 &#124; 服务ID>            |                                               |
| 停止所有服务                                      | pm2 stop all                                     |                                               |
| 永久删除某个服务                                  | pm2 delete <服务文件路径 &#124; 服务ID>          |                                               |
| 永久删除所有服务                                  | pm2 delete all                                   |                                               |
| 查看所有的服务列表                                | pm2 ls                                           |                                               |
| 查看所有的进程状态                                | pm2 status                                       |                                               |
| 实时查看某个node服务中的打印信息                  | pm2 logs <服务ID>                                |                                               |
| 实时查看所有node服务中的打印信息                  | pm2 logs                                         |                                               |
| 查看某一个进程的信息                              | pm2 describe <服务文件路径 &#124; 服务ID>        |                                               |
| 超过使用内存上限后自动重启(超过100M自动重启)      | pm2 start big-array.js --max-memory-restart 100M |                                               |