Skip to content

Commit 8e00324

Browse files
committed
docs: Supplementary documents
1 parent bdf719a commit 8e00324

File tree

1 file changed

+45
-1
lines changed

1 file changed

+45
-1
lines changed

README.md

Lines changed: 45 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
nodejs 实现文件上传功能
33

44
### 支持功能
5+
> 目前均为免费版本,Plus 版本还在规划中,Lite 和 Full 版本永久免费。
56
67
| 功能 | Lite(缩减版) | Full(全量版) | Plus(增强版) |
78
|--------------|----------------|----------------|--------------|
@@ -15,6 +16,49 @@ nodejs 实现文件上传功能
1516
| 公开失效时间 ||||
1617
| 高级搜索功能 ||||
1718

19+
### 使用方法
20+
21+
```shell
22+
yarn install
23+
24+
yarn dev
25+
```
26+
27+
> 启动完成之后,会自动创建 resource 作为资源文件夹,而 provisional 会作为临时文件夹。后续会考虑开启定时任务进行清理。
28+
29+
### 目录结构
30+
31+
```shell
32+
├── LICENSE
33+
├── README.md
34+
├── constants
35+
│ └── file.js
36+
├── index.js
37+
├── models # 表模型
38+
│ └── files.js
39+
├── package.json
40+
├── public
41+
│ ├── icons
42+
│ │ ├── doc.png
43+
│ │ ├── document.png
44+
│ │ ├── folders.png
45+
│ │ ├── pdf.png
46+
│ │ ├── psd.png
47+
│ │ ├── shared_folders.png
48+
│ │ ├── unknown_file_types.png
49+
│ │ ├── video.png
50+
│ │ ├── xlsx.png
51+
│ │ └── zip.png
52+
│ └── index.html
53+
├── routers # 路由
54+
│ └── files.js
55+
├── utils
56+
│ ├── createPath.js
57+
│ ├── dbInstance.js
58+
│ ├── detectFileType.js
59+
│ └── responseFormatter.js
60+
└── yarn.lock
61+
```
1862

1963
### 环境变量
2064
创建一个 `.env.local` 文件,在里面配置对应的环境变量
@@ -32,7 +76,7 @@ MYSQL_PORT=3306
3276

3377
### 创建表的字段说明
3478

35-
> 启动项目则会,自动创建,默认创建 `files` 表结构
79+
> 启动项目则会,自动创建创建 `files` 表结构
3680
3781
```sql
3882
CREATE TABLE files (

0 commit comments

Comments
 (0)