Commit c247dcd 1 parent 9feceed commit c247dcd Copy full SHA for c247dcd
File tree 2 files changed +30
-26
lines changed
2 files changed +30
-26
lines changed Original file line number Diff line number Diff line change 21
21
22
22
23
23
24
- ## 前序准备
24
+ ## 🎯 前序准备
25
25
26
26
请确保安装了 [ Node.js] ( https://nodejs.org/ ) (>= 10.18.1)
27
27
28
- ## 特性
28
+ ## ✨ 特性
29
29
30
- 🌌 解耦了业务层和控制层
30
+ * 🌈 解耦了业务层和控制层
31
31
32
- 🐣 可能是 Puppeteer 项目的最佳实践
32
+ * 🛡 可能是 Puppeteer 项目的最佳实践
33
33
34
- 🧩 可配置的路由
34
+ * 🧩 可配置的路由
35
35
36
- 🚧 内置 Eslint 语法风格检查
36
+ * 🚧 内置 Eslint 语法风格检查
37
37
38
- ⚡ 使用 Rollup 快速构建
38
+ * ⚡ 使用 Rollup 快速构建
39
39
40
- 🕊 内置了 PDF 水印、页眉和页脚,可自行修改及扩展
40
+ * 🔌 内置了 PDF 水印、页眉和页脚,可自行修改及扩展
41
41
42
- 🧲 支持合并多个 PDF 文件
42
+ * 🧲 支持合并多个 PDF 文件
43
43
44
- 🔥 支持开发环境下的模块热更新
44
+ * 🔥 支持开发环境下的模块热更新
45
45
46
46
## 项目结构
47
47
54
54
│ └── routes.ts --- 用于配置路由元信息 <a href =" #路由配置 " >👉 路由配置</a >
55
55
</pre >
56
56
57
- ## 安装
57
+ ## ⚡ 快速开始
58
+
59
+ ### 1. 安装
58
60
59
61
``` bash
60
62
pnpm install
61
63
```
62
64
63
- ## 开发环境运行
65
+ ### 2. 开发环境运行
64
66
65
67
``` bash
66
68
pnpm dev
67
69
```
68
70
69
- ## 生产环境运行
71
+ ### 3. 生产环境运行
70
72
71
73
该项目已内置 ` pm2 ` ,在构建完毕后运行 ` pnpm start ` 即可使用 ` pm2 ` 管理进程。
72
74
Original file line number Diff line number Diff line change @@ -21,27 +21,27 @@ English | [中文](README-zh.md)
21
21
22
22
23
23
24
- ## Prerequisites
24
+ ## 🎯 Prerequisites
25
25
26
26
Please make sure that [ Node.js] ( https://nodejs.org/ ) (>= 10.18.1) is installed on your operating system.
27
27
28
- ## Feature
28
+ ## ✨ Features
29
29
30
- 🌌 Separation business logic and Controllers.
30
+ * 🌈 Separation business logic and Controllers.
31
31
32
- 🐣 Probably the best practice for Puppeteer project.
32
+ * 🛡 Probably the best practice for Puppeteer project.
33
33
34
- 🧩 Configured routing.
34
+ * 🧩 Configured routing.
35
35
36
- 🚧 Eslint configuration.
36
+ * 🚧 Eslint configuration.
37
37
38
- ⚡ Fast build with Rollup.
38
+ * ⚡ Fast build with Rollup.
39
39
40
- 🕊 Extensible PDF watermark, header and footer.
40
+ * 🔌 Extensible PDF watermark, header and footer.
41
41
42
- 🧲 Supports merging of multiple PDF files.
42
+ * 🧲 Supports merging of multiple PDF files.
43
43
44
- 🔥 HMR.
44
+ * 🔥 HMR.
45
45
46
46
## Project structure
47
47
@@ -54,19 +54,21 @@ Please make sure that [Node.js](https://nodejs.org/) (>= 10.18.1) is installed o
54
54
│ └── routes.ts --- Configs for routing controllers <a href =" #Routing " >👉 Routing</a >
55
55
</pre >
56
56
57
- ## Installation
57
+ ## ⚡ Quick Start
58
+
59
+ ### 1. Installation
58
60
59
61
``` bash
60
62
pnpm install
61
63
```
62
64
63
- ## Running Development
65
+ ### 2. Running Development
64
66
65
67
``` bash
66
68
pnpm dev
67
69
```
68
70
69
- ## Running Production
71
+ ### 3. Running Production
70
72
71
73
The project has built-in a ` pm2 ` , running the ` pnpm start ` will automatically manage the process by ` pm2 ` .
72
74
You can’t perform that action at this time.
0 commit comments