chore: README.md
This commit is contained in:
parent
6cafc07e0d
commit
befad1cbe1
91
README.md
91
README.md
|
@ -6,35 +6,98 @@
|
|||
|
||||
![cover](./docs/cover.png)
|
||||
|
||||
## 使用
|
||||
> 确保 `node >= 18`
|
||||
## Route Map
|
||||
[x] 多会话
|
||||
|
||||
[x] 多语言
|
||||
|
||||
[x] 主题
|
||||
|
||||
[x] 用户模块
|
||||
|
||||
[x] More...
|
||||
|
||||
## 前置要求
|
||||
|
||||
### Node
|
||||
|
||||
`node` 版本需要 >= 18,使用 [nvm](https://github.com/nvm-sh/nvm) 可管理本地多个 `node` 版本
|
||||
|
||||
```shell
|
||||
node -v
|
||||
```
|
||||
|
||||
### PNPM
|
||||
如果你没有安装过 `pnpm`
|
||||
```shell
|
||||
npm install pnpm -g
|
||||
```
|
||||
|
||||
安装依赖
|
||||
### OpenAI API KEy
|
||||
获取 [OpenAI API key](https://platform.openai.com/overview) 并填写到本地环境变量
|
||||
```
|
||||
# service/.env 文件
|
||||
|
||||
OPENAI_API_KEY='Your key'
|
||||
```
|
||||
|
||||
## 安装依赖
|
||||
|
||||
> 为了简便 `后端开发人员` 的了解负担,所以并没有采用前端 `workspace` 模式,而是分文件夹存放。如果只需要前端页面做二次开发,删除 `service` 文件夹即可。
|
||||
|
||||
### 后端服务
|
||||
|
||||
进入文件夹 `/service` 运行以下命令
|
||||
|
||||
```shell
|
||||
pnpm install
|
||||
```
|
||||
|
||||
获取 [OpenAI API key](https://platform.openai.com/overview) 到本地环境变量
|
||||
|
||||
```
|
||||
# .env
|
||||
OPENAI_API_KEY="Your Key"
|
||||
```
|
||||
|
||||
运行服务
|
||||
### 网页
|
||||
根目录下运行以下命令
|
||||
```shell
|
||||
pnpm run service
|
||||
pnpm bootstrap
|
||||
```
|
||||
|
||||
运行网页
|
||||
|
||||
## 运行
|
||||
### 后端服务
|
||||
|
||||
进入文件夹 `/service` 运行以下命令
|
||||
|
||||
```shell
|
||||
pnpm run dev
|
||||
pnpm start
|
||||
```
|
||||
|
||||
### 网页
|
||||
根目录下运行以下命令
|
||||
```shell
|
||||
pnpm dev
|
||||
```
|
||||
|
||||
## 打包
|
||||
### 后端服务
|
||||
> 如果你不需要本项目的 `node` 接口,可以省略如下操作
|
||||
|
||||
复制 `service` 文件夹到你有 `node` 服务环境的服务器上。(搜索关键字:`express部署)`
|
||||
|
||||
操作上述 `安装` 和 `运行` 服务。
|
||||
|
||||
### 网页
|
||||
根目录下运行以下命令,然后将 `dist` 文件夹复制到你的托管服务器上
|
||||
|
||||
```shell
|
||||
pnpm build
|
||||
```
|
||||
|
||||
### 常见问题
|
||||
Q: 如果只使用前端页面,在哪里改请求接口?
|
||||
|
||||
A: 根目录下 `.env` 文件中的 `VITE_GLOB_API_URL` 字段。
|
||||
|
||||
Q: 文件保存时全部爆红色?
|
||||
|
||||
A: `vscode` 请安装项目推荐插件,或在手动安装 `Eslint` 插件。
|
||||
|
||||
## License
|
||||
MIT © [ChenZhaoYu](./license)
|
||||
|
|
BIN
docs/cover.png
BIN
docs/cover.png
Binary file not shown.
Before Width: | Height: | Size: 94 KiB After Width: | Height: | Size: 200 KiB |
Loading…
Reference in New Issue