docs: update readme

This commit is contained in:
ShawnPhang 2023-07-27 10:12:53 +08:00
parent 96ab00cd0d
commit 5a2770d077
2 changed files with 19 additions and 22 deletions

View File

@ -62,10 +62,9 @@ npm run serve
### 打包
```
npm run v-build <- 前端页面
npm run build <- 图片生成服务 sreenshot 目录下
```
| 前端页面 | 图片生成服务 |
| ----------------- | ------------------------------------- |
| `npm run v-build` | `cd sreenshot` <br /> `npm run build` |
### 服务端
@ -77,10 +76,6 @@ npm run build <- 图片生成服务( sreenshot 目录下)
> 打包注意事项与服务器配置相关请进入该目录下查看 README 文件说明。
目录结构比较简单,主要就实现了三个接口,其中 `api/screenshots` 即是项目中所使用到的图片生成接口,在真实生产项目中可以把该服务单独部署,于内网调用,这样利于做一些鉴权之类的处理。
另外 `api/printscreen` 这个接口实现的是网页截图的 API该接口可以传入一个 URL 对整个网页进行截图,本项目中不依赖此接口。
### Docker 容器部署
可以通过 Docker 运行一个带 Linux 浏览器的容器,[参考说明](https://xp.palxp.com/#/articles/1689319644311?id=docker%e5%ae%b9%e5%99%a8)。
@ -98,7 +93,7 @@ npm run build <- 图片生成服务( sreenshot 目录下)
Q**我想二次开发,但是不会编写代码,可以付费开发吗?**
A抱歉本人时间精力有限无法提供私有化部署或二次开发的服务不接受定制化开发的需求。如果您对项目有任何建议或意见非常欢迎与我交流。
A抱歉本人时间精力有限,无法提供私有化部署或二次开发的服务,不接受定制化开发的需求。如果您对项目有任何建议或意见,非常欢迎与我交流。
Q**服务端源码不开源吗?**
@ -108,8 +103,6 @@ A考虑到服务端的开发语言、数据库类型都可能不尽相同
项目最早使用 Vue2 开发,后改用 Vue3 重构,所以有部分代码混合了 Options 写法。
如果你也对开发图片编辑器感兴趣,欢迎一起共建项目
或许你在工作中有这类需求,这个项目能给到你一些微薄帮助的话,那就再好不过了
或许你在工作中有这类需求,如果能给到你一些微薄的帮助,那就更好不过了!
目前本项目也还在不断迭代中,有很多的不足之处,我也是一边学习一边成长。开源不易,希望看到这里的你可以给本项目点个 Star 支持一下~ 感谢!
目前本项目也还在不断迭代中,有很多的不足之处,我也是一边学习一边成长。开源不易,希望看到这里的你可以给本项目点个 **Star** 支持一下~ 感谢!

View File

@ -1,17 +1,21 @@
# Node截图服务
## Node截图服务
### npm install 或 yarn
目录结构比较简单,主要就实现了三个接口,其中 `api/screenshots` 即是项目中所使用到的图片生成接口,在真实生产项目中可以把该服务单独部署,于内网调用,这样利于做一些鉴权之类的处理。
安装依赖
另外 `api/printscreen` 这个接口实现的是网页截图的 API该接口可以传入一个 URL 对整个网页进行截图,本项目中没有使用到此接口。
### npm run dev
### 安装依赖
运行 ts-node并监听文件修改自动热更新
`npm install``yarn`
### npm run build
### 启动项目并热更新
使用 webpack 打包文件
`npm run dev`
### 打包
`npm run build`
#### 打包说明
@ -38,6 +42,6 @@ apt-get update
apt-get install -y google-chrome-stable // 安装最新稳定版谷歌浏览器
```
### build:apidoc
### 生成 API 文档
生成 API 文档
`build:apidoc`