Skip to content

Commit 1504c9f

Browse files
YidadaaYidadaa
committed
doc: update readme
1 parent 76db385 commit 1504c9f

File tree

6 files changed

+135
-91
lines changed

6 files changed

+135
-91
lines changed

‎LICENSE

+75
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
版权所有（c）<2023><Zhang Yifei>
2+
3+
反996许可证版本1.0
4+
5+
在符合下列条件的情况下，
6+
特此免费向任何得到本授权作品的副本（包括源代码、文件和/或相关内容，以下统称为“授权作品”
7+
）的个人和法人实体授权：被授权个人或法人实体有权以任何目的处置授权作品，包括但不限于使
8+
用、复制，修改，衍生利用、散布，发布和再许可：
9+
10+
11+
1. 个人或法人实体必须在许可作品的每个再散布或衍生副本上包含以上版权声明和本许可证，不
12+
得自行修改。
13+
2. 个人或法人实体必须严格遵守与个人实际所在地或个人出生地或归化地、或法人实体注册地或
14+
经营地（以较严格者为准）的司法管辖区所有适用的与劳动和就业相关法律、法规、规则和
15+
标准。如果该司法管辖区没有此类法律、法规、规章和标准或其法律、法规、规章和标准不可
16+
执行，则个人或法人实体必须遵守国际劳工标准的核心公约。
17+
3. 个人或法人不得以任何方式诱导或强迫其全职或兼职员工或其独立承包人以口头或书面形式同
18+
意直接或间接限制、削弱或放弃其所拥有的，受相关与劳动和就业有关的法律、法规、规则和
19+
标准保护的权利或补救措施，无论该等书面或口头协议是否被该司法管辖区的法律所承认，该
20+
等个人或法人实体也不得以任何方法限制其雇员或独立承包人向版权持有人或监督许可证合规
21+
情况的有关当局报告或投诉上述违反许可证的行为的权利。
22+
23+
该授权作品是"按原样"提供，不做任何明示或暗示的保证，包括但不限于对适销性、特定用途适用
24+
性和非侵权性的保证。在任何情况下，无论是在合同诉讼、侵权诉讼或其他诉讼中，版权持有人均
25+
不承担因本软件或本软件的使用或其他交易而产生、引起或与之相关的任何索赔、损害或其他责任。
26+
27+
28+
------------------------- ENGLISH ------------------------------
29+
30+
31+
Copyright (c) <2023> <Zhang Yifei>
32+
33+
Anti 996 License Version 1.0 (Draft)
34+
35+
Permission is hereby granted to any individual or legal entity obtaining a copy
36+
of this licensed work (including the source code, documentation and/or related
37+
items, hereinafter collectively referred to as the "licensed work"), free of
38+
charge, to deal with the licensed work for any purpose, including without
39+
limitation, the rights to use, reproduce, modify, prepare derivative works of,
40+
publish, distribute and sublicense the licensed work, subject to the following
41+
conditions:
42+
43+
1. The individual or the legal entity must conspicuously display, without
44+
modification, this License on each redistributed or derivative copy of the
45+
Licensed Work.
46+
47+
2. The individual or the legal entity must strictly comply with all applicable
48+
laws, regulations, rules and standards of the jurisdiction relating to
49+
labor and employment where the individual is physically located or where
50+
the individual was born or naturalized; or where the legal entity is
51+
registered or is operating (whichever is stricter). In case that the
52+
jurisdiction has no such laws, regulations, rules and standards or its
53+
laws, regulations, rules and standards are unenforceable, the individual
54+
or the legal entity are required to comply with Core International Labor
55+
Standards.
56+
57+
3. The individual or the legal entity shall not induce or force its
58+
employee(s), whether full-time or part-time, or its independent
59+
contractor(s), in any methods, to agree in oral or written form,
60+
to directly or indirectly restrict, weaken or relinquish his or
61+
her rights or remedies under such laws, regulations, rules and
62+
standards relating to labor and employment as mentioned above,
63+
no matter whether such written or oral agreement are enforceable
64+
under the laws of the said jurisdiction, nor shall such individual
65+
or the legal entity limit, in any methods, the rights of its employee(s)
66+
or independent contractor(s) from reporting or complaining to the copyright
67+
holder or relevant authorities monitoring the compliance of the license
68+
about its violation(s) of the said license.
69+
70+
THE LICENSED WORK IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
71+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
72+
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE COPYRIGHT
73+
HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
74+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN ANY WAY CONNECTION
75+
WITH THE LICENSED WORK OR THE USE OR OTHER DEALINGS IN THE LICENSED WORK.

‎README.md

+55-89
Original file line numberDiff line numberDiff line change
@@ -1,89 +1,55 @@
1-
This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
2-
3-
## Getting Started
4-
5-
First, run the development server:
6-
7-
```bash
8-
npm run dev
9-
# or
10-
yarn dev
11-
# or
12-
pnpm dev
13-
```
14-
15-
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
16-
17-
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
18-
19-
[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.ts`.
20-
21-
The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages.
22-
23-
This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
24-
25-
## Learn More
26-
27-
To learn more about Next.js, take a look at the following resources:
28-
29-
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
30-
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
31-
32-
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
33-
34-
## Deploy on Vercel
35-
36-
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
37-
38-
Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
39-
40-
## build log
41-
### raw
42-
Route (app) Size First Load JS
43-
┌ ○ / 449 kB 517 kB
44-
├ λ /api/chat 0 B 0 B
45-
└ ℇ /api/chat-stream 0 B 0 B
46-
+ First Load JS shared by all 68.8 kB
47-
├ chunks/455-0a9fbb1180548580.js 66.4 kB
48-
├ chunks/main-app-19b36671ec6a549e.js 204 B
49-
└ chunks/webpack-dd78d1150b6f4f4a.js 2.15 kB
50-
51-
Route (pages) Size First Load JS
52-
─ ○ /404 179 B 84.6 kB
53-
+ First Load JS shared by all 84.4 kB
54-
├ chunks/main-303e01cd7449e20b.js 82.1 kB
55-
├ chunks/pages/_app-907dedfd0e4177db.js 192 B
56-
57-
### dynamic markdown
58-
Route (app) Size First Load JS
59-
┌ ○ / 64.2 kB 133 kB
60-
├ λ /api/chat 0 B 0 B
61-
└ ℇ /api/chat-stream 0 B 0 B
62-
+ First Load JS shared by all 68.9 kB
63-
├ chunks/455-0a9fbb1180548580.js 66.4 kB
64-
├ chunks/main-app-19b36671ec6a549e.js 204 B
65-
└ chunks/webpack-3b3874680bea117d.js 2.26 kB
66-
67-
Route (pages) Size First Load JS
68-
─ ○ /404 179 B 84.7 kB
69-
+ First Load JS shared by all 84.5 kB
70-
├ chunks/main-303e01cd7449e20b.js 82.1 kB
71-
├ chunks/pages/_app-907dedfd0e4177db.js 192 B
72-
└ chunks/webpack-3b3874680bea117d.js 2.26 kB
73-
74-
### dynamic emoji
75-
Route (app) Size First Load JS
76-
┌ ○ / 16.1 kB 85 kB
77-
├ λ /api/chat 0 B 0 B
78-
└ ℇ /api/chat-stream 0 B 0 B
79-
+ First Load JS shared by all 68.9 kB
80-
├ chunks/455-0a9fbb1180548580.js 66.4 kB
81-
├ chunks/main-app-19b36671ec6a549e.js 204 B
82-
└ chunks/webpack-2bfaffd64d73d7a1.js 2.33 kB
83-
84-
Route (pages) Size First Load JS
85-
─ ○ /404 179 B 84.8 kB
86-
+ First Load JS shared by all 84.6 kB
87-
├ chunks/main-303e01cd7449e20b.js 82.1 kB
88-
├ chunks/pages/_app-907dedfd0e4177db.js 192 B
89-
└ chunks/webpack-2bfaffd64d73d7a1.js 2.33 kB
1+
<div align="center">
2+
<img src="./static/icon.svg" alt="预览"/>
3+
4+
<h1 align="center">ChatGPT Next Web</h1>
5+
6+
一键免费部署你的私人 ChatGPT 网页应用。
7+
8+
[开始试用](https://chat-gpt-next-web.vercel.app/) / [反馈问题](https://github.com/Yidadaa/ChatGPT-Next-Web/issues)
9+
10+
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FYidadaa%2FChatGPT-Next-Web&env=OPENAI_API_KEY)
11+
12+
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/Yidadaa/ChatGPT-Next-Web)
13+
14+
</div>
15+
16+
## 主要功能
17+
18+
- 在 1 分钟内使用 Vercel 的 Serverless 能力**免费一键部署**
19+
- 精心设计的 UI，同时兼容电脑和手机访问的响应式设计，支持深色模式
20+
- 极致优化的首屏加载速度（~85kb）
21+
- 自动压缩历史记录，在节省 Token 的同时支持超长对话记录
22+
- 一键导出聊天记录，完整的 Markdown 支持
23+
- 你拥有自己的域名？好上加好，绑定后即可在任何地方**无障碍**快速访问
24+
25+
## 使用
26+
27+
1. 准备好你的 [OpenAI API Key](https://platform.openai.com/account/api-keys);
28+
2. 点击右侧按钮开始部署：
29+
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FYidadaa%2FChatGPT-Next-Web&env=OPENAI_API_KEY)
30+
3. 部署完毕后，即可开始使用；
31+
4. （可选）[绑定自定义域名](https://vercel.com/docs/concepts/projects/domains/add-a-domain)。
32+
33+
## 开发
34+
35+
点击下方按钮，开始二次开发：
36+
37+
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/Yidadaa/ChatGPT-Next-Web)
38+
39+
## 截图
40+
41+
<div align="center">主界面</div>
42+
43+
![主界面](./static/cover.png)
44+
45+
<div align="center">设置页</div>
46+
47+
![设置](./static/settings.png)
48+
49+
<div align="center">更多展示</div>
50+
51+
![更多展示](./static/more.png)
52+
53+
## LICENSE
54+
55+
- [Anti 996 License](https://github.com/kattgu7/Anti-996-License/blob/master/LICENSE_CN_EN)

‎app/components/home.tsx

+5-2
Original file line numberDiff line numberDiff line change
@@ -273,7 +273,7 @@ export function Chat(props: { showSideBar?: () => void }) {
273273
className="markdown-body"
274274
onContextMenu={(e) => {
275275
if (selectOrCopy(e.currentTarget, message.content)) {
276-
e.preventDefault()
276+
e.preventDefault();
277277
}
278278
}}
279279
>
@@ -463,7 +463,10 @@ export function Home() {
463463
/>
464464
</div>
465465
<div className={styles["sidebar-action"]}>
466-
<a href="https://github.com/Yidadaa" target="_blank">
466+
<a
467+
href="https://github.com/Yidadaa/ChatGPT-Next-Web"
468+
target="_blank"
469+
>
467470
<IconButton icon={<GithubIcon />} />
468471
</a>
469472
</div>

‎static/cover.png

234 KB
Loading

‎static/more.png

270 KB
Loading

‎static/settings.png

187 KB
Loading

0 commit comments

Comments
 (0)