Skip to content

Commit f9ecfae

Browse files
committed
Update README
1 parent 3806c63 commit f9ecfae

File tree

2 files changed

+16
-26
lines changed

2 files changed

+16
-26
lines changed

README.md

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
English | [简体中文](./README.zh-CN.md)
44

5+
ChatGPT Minimal implements core ChatGPT features with a minimal codebase. Built with Next.js. Clean code, easy to extend.
6+
57
## Demo
68

79
Try the [ChatGPT Minimal Demo Site](https://chatgpt-minimal.vercel.app).
@@ -13,28 +15,26 @@ Try the [ChatGPT Minimal Demo Site](https://chatgpt-minimal.vercel.app).
1315

1416
## Features
1517

16-
ChatGPT Minimal is a clean, minimal codebase that implements core ChatGPT features with Next.js. Supports OpenAI, Azure OpenAI, and any OpenAI-compatible provider (DeepSeek, Ollama, etc.).
17-
1818
**What this project includes:**
1919

2020
- **Real-time streaming chat** with Server-Sent Events
2121
- **Text + image chat** (image upload and paste)
2222
- **Web search integration** (with source citations when supported by provider/model)
2323
- **Markdown rendering** with syntax highlighting
24-
- **OpenAI, Azure OpenAI, and OpenAI-compatible providers**
24+
- **Supports OpenAI, Azure OpenAI, and OpenAI-compatible providers**
2525
- **Light/Dark mode toggle**
2626

27-
Looking for a full-featured ChatGPT clone? [ChatGPT Lite](https://github.com/blrchen/chatgpt-lite) extends this project with:
27+
Looking for a more complete version? [ChatGPT Lite](https://github.com/blrchen/chatgpt-lite) builds on this project's codebase and adds:
2828

2929
- Persona system with custom system prompts
3030
- Multi-conversation management
3131
- File attachments (PDF, XLSX/CSV, text files)
3232
- Voice input
33-
- 40+ built-in themes
33+
- 40+ UI themes
3434

3535
## Deployment
3636

37-
Refer to [Environment Variables](#environment-variables) before deployment.
37+
For required environment variables, see [Environment Variables](#environment-variables).
3838

3939
### Deploy to Vercel
4040

@@ -80,7 +80,7 @@ docker run -d -p 3000:3000 \
8080
| Name | Required | Description | Default Value |
8181
| ------------------- | -------- | ------------------------------------------------------------------------------------------------- | ------------------------ |
8282
| OPENAI_API_KEY | Yes | API key from [OpenAI Platform](https://platform.openai.com/account/api-keys). | - |
83-
| OPENAI_API_BASE_URL | No | Base URL for OpenAI-compatible endpoints. If it does not end with `/v1`, the app will append it. | `https://api.openai.com/v1` |
83+
| OPENAI_API_BASE_URL | No | Base URL for OpenAI-compatible endpoints. If it does not end with `/v1`, the app will append it. | `https://api.openai.com` |
8484
| OPENAI_MODEL | No | Model name for OpenAI mode. | `gpt-4o-mini` |
8585

8686
### Azure OpenAI
@@ -91,11 +91,6 @@ docker run -d -p 3000:3000 \
9191
| AZURE_OPENAI_API_KEY | Yes | Azure OpenAI API key. |
9292
| AZURE_OPENAI_DEPLOYMENT | Yes | Azure OpenAI deployment name (not the model name). |
9393

94-
### Provider Selection Notes
95-
96-
- If Azure and OpenAI variables are both configured, **Azure is used first**.
97-
- Web search requires model/provider tool support. When unavailable, the app automatically falls back to regular chat.
98-
9994
## Contribution
10095

10196
PRs of all sizes are welcome.

README.zh-CN.md

Lines changed: 9 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
[English](./README.md) | 简体中文
44

5+
ChatGPT Minimal 以最小代码量实现了 ChatGPT 核心功能。基于 Next.js,代码清晰,易于扩展。
6+
57
## 演示
68

79
访问 [ChatGPT Minimal 演示网站](https://chatgpt-minimal.vercel.app)
@@ -13,28 +15,26 @@
1315

1416
## 功能介绍
1517

16-
ChatGPT Minimal 是一个代码简洁、结构清晰的 Next.js 项目,实现了 ChatGPT 核心功能,支持 OpenAI、Azure OpenAI 及任何 OpenAI 兼容 API(DeepSeek、Ollama 等)。
17-
1818
**本项目包含:**
1919

2020
- **实时流式聊天**(Server-Sent Events)
2121
- **文本 + 图片聊天**(支持图片上传与粘贴)
22-
- **联网搜索**在模型支持时显示来源引用
22+
- **联网搜索**模型支持时可显示来源引用
2323
- **Markdown 渲染**(含代码高亮)
2424
- **支持 OpenAI、Azure OpenAI 及 OpenAI 兼容 API 提供商**
25-
- **深色/浅色模式**
25+
- **深色/浅色主题切换**
2626

27-
如果你需要更完整的 ChatGPT 体验,可以看看 [ChatGPT Lite](https://github.com/blrchen/chatgpt-lite)它额外提供了
27+
如果你需要一个功能更完整的版本,可以看看 [ChatGPT Lite](https://github.com/blrchen/chatgpt-lite)它在本项目的代码基础上额外实现了
2828

2929
- 角色系统与自定义系统提示词
3030
- 多会话管理
3131
- 文件附件(PDF、XLSX/CSV、文本文件)
3232
- 语音输入
33-
- 40+ 内置主题
33+
- 40+ UI 主题可选
3434

3535
## 部署
3636

37-
部署前请先阅读 [环境变量](#环境变量) 章节。
37+
部署所需的环境变量请参考[环境变量](#环境变量)章节。
3838

3939
### 部署到 Vercel
4040

@@ -79,8 +79,8 @@ docker run -d -p 3000:3000 \
7979
| 名称 | 必填 | 说明 | 默认值 |
8080
| ------------------- | ---- | --------------------------------------------------------------------------------------------- | -------------------------- |
8181
| OPENAI_API_KEY ||[OpenAI Platform](https://platform.openai.com/account/api-keys) 获取的 API Key。 | - |
82-
| OPENAI_API_BASE_URL || OpenAI 兼容 API 的 Base URL。若未以 `/v1` 结尾,会自动补上。 | `https://api.openai.com/v1` |
83-
| OPENAI_MODEL || OpenAI 模式下使用的模型名称| `gpt-4o-mini` |
82+
| OPENAI_API_BASE_URL || OpenAI 兼容 API 的 Base URL。若未以 `/v1` 结尾,会自动补上。 | `https://api.openai.com` |
83+
| OPENAI_MODEL || OpenAI 使用的模型名称| `gpt-4o-mini` |
8484

8585
### Azure OpenAI
8686

@@ -90,11 +90,6 @@ docker run -d -p 3000:3000 \
9090
| AZURE_OPENAI_API_KEY || Azure OpenAI API Key。 |
9191
| AZURE_OPENAI_DEPLOYMENT || Azure OpenAI 部署名称(不是模型名)。 |
9292

93-
### 提供方选择说明
94-
95-
- 当 Azure 与 OpenAI 的变量同时存在时,**优先使用 Azure**
96-
- 联网搜索依赖模型能力。若不支持,会自动回退到普通聊天。
97-
9893
## 贡献
9994

10095
欢迎提交各种规模的 PR。

0 commit comments

Comments
 (0)