Skip to content

Commit

Permalink
doc: add zh README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
guangzhengli committed Apr 5, 2023
1 parent 53d050a commit 2693d4d
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 47 deletions.
50 changes: 3 additions & 47 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

# ChatFiles

EN | [中文文档](README.zh.md)

> this repository use [jerryjliu/llama_index](https://github.com/jerryjliu/llama_index), based on [mckaywrigley/chatbot-ui](https://github.com/mckaywrigley/chatbot-ui), inspired by [madawei2699/myGPTReader](https://github.com/madawei2699/myGPTReader)
![Chatfiles](./doc/chatfiles.png)
Expand Down Expand Up @@ -45,50 +47,4 @@ create a file named .env with value(OPENAI_API_KEY=your token)

```shell
python3 server.py
```

## 与文件交流

> 这个项目使用 [jerryjliu/llama_index](https://github.com/jerryjliu/llama_index), 项目代码基于 [mckaywrigley/chatbot-ui](https://github.com/mckaywrigley/chatbot-ui) 开发, 受 [madawei2699/myGPTReader](https://github.com/madawei2699/myGPTReader) 所启发而创建。

**上传文件然后与之对话.**

## 如何使用
1. 克隆此存储库。
2. 在根路径上创建 .env 文件。
3. 将您的 OpenAI Key 放入 .env 文件中,使用 OPENAI_API_KEY='您的令牌'。

使用 docker compose 启动项目
```shell
docker compose up
```

打开浏览器输入: http://localhost:3000

### 与文件对话
上传文件。
问与文件有关的内容。

### 与 GPT 对话
直接发送消息,而无需上传文件。

## 如何本地运行
### chatfiles-ui

```shell
cd chatfiles-ui
npm install
npm run dev
```

### chatfiles
```shell
cd chatfiles
```

创建一个名为 .env的文件,里面设置值为(OPENAI_API_KEY=your token)

```shell
python3 server.py
```
```
43 changes: 43 additions & 0 deletions README.zh.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
[![My Skills](https://skillicons.dev/icons?i=nextjs,tailwind,react,python,flask)](https://skillicons.dev)

# ChatFiles
**上传文件然后与之对话.**

## 如何使用
1. 克隆此存储库。
2. 在根路径上创建 .env 文件。
3. 将您的 OpenAI Key 放入 .env 文件中,使用 OPENAI_API_KEY='您的令牌'。

使用 docker compose 启动项目
```shell
docker compose up
```

打开浏览器输入: http://localhost:3000

### 与文件对话
上传文件。
问与文件有关的内容。

### 与 GPT 对话
直接发送消息,而无需上传文件。

## 如何本地运行
### chatfiles-ui

```shell
cd chatfiles-ui
npm install
npm run dev
```

### chatfiles
```shell
cd chatfiles
```

创建一个名为 .env的文件,里面设置值为(OPENAI_API_KEY=your token)

```shell
python3 server.py
```

0 comments on commit 2693d4d

Please sign in to comment.