Skip to content

Commit

Permalink
feat: Modify the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
JerryFan626 committed Jul 12, 2023
1 parent d184dfb commit b12ade1
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 24 deletions.
15 changes: 3 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,12 +148,12 @@ Note: If local debugging is required
$ git clone [email protected]:alibaba/Chat2DB.git
```

- Front-End installation
- Front-End debug

```bash
$ cd Chat2DB/chat2db-client
$ npm install # Mounting front-end dependency
$ npm run build:prod # Package js to the source directory on the back end
$ yarn
$ yarn run start:web
```

- Backend debug
Expand All @@ -163,15 +163,6 @@ $ cd ../chat2db-server
$ mvn clean install # maven 3.8 or later needs to be installed
$ cd chat2db-server/chat2db-server-start/target/
$ java -jar -Dchatgpt.apiKey=xxxxx chat2db-server-start.jar # To launch the chat application, you need to enter the ChatGPT key for the chatgpt.apiKey. Without entering it, you won't be able to use the AIGC function.
$ # open http://127.0.0.1:10821 to start debug Note: Front-end installation is required
```

- Front-End debug

```bash
$ cd Chat2DB/chat2db-client
$ yarn
$ npm run start:web
```

## 📑 Documentation
Expand Down
15 changes: 3 additions & 12 deletions README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,12 +154,12 @@ https://github.com/chat2db/Chat2DB/assets/22975773/b58db908-5768-4a71-aa30-135d2
$ git clone [email protected]:chat2db/Chat2DB.git
```

- 前端安装
- 前端调试

```bash
$ cd Chat2DB/chat2db-client
$ npm install # 安装前端依赖
$ npm run build:prod # 把js打包生成到后端的source目录
$ yarn
$ yarn run start:web
```

- 后端调试
Expand All @@ -169,15 +169,6 @@ $ cd ../chat2db-server
$ mvn clean install # 需要安装maven 3.8以上版本
$ cd chat2db-server/chat2db-server-start/target/
$ java -jar -Dchatgpt.apiKey=xxxxx chat2db-server-start.jar # 启动应用 chatgpt.apiKey 需要输入ChatGPT的key,如果不输入无法使用AIGC功能
$ # 打开 http://127.0.0.1:10821 开启调试 注:需要进行前端安装
```

- 前端调试

```bash
$ cd Chat2DB/chat2db-client
$ yarn
$ npm run start:web
```

## 📑 文档
Expand Down

0 comments on commit b12ade1

Please sign in to comment.