diff --git a/README.md b/README.md index c27e039..61318a4 100644 --- a/README.md +++ b/README.md @@ -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) @@ -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 -``` +``` \ No newline at end of file diff --git a/README.zh.md b/README.zh.md new file mode 100644 index 0000000..0b4105c --- /dev/null +++ b/README.zh.md @@ -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 +```