项目部署
AI Short 是一个开源项目,你可以自由修改网站的名称和说明。
- 要更改页面名称,请编辑
docusaurus.config.js
文件。 - 要修改使用说明,请前往
docs
目录。 - 若要修改提示词,你可以在
src/data/prompt.json
中找到它们。如果你只需要修改单个语言,比如中文,可以直接编辑src/data/prompt_zh.json
。 - 目前,用户后端已连接到一个共用后台系统。如果需要,你可以自行建立后端,相关接口位于
src/api.js
文件中。
CodeUpdateHandler.py
是用于批量处理多语言部署的脚本。完成修改后,执行 python CodeUpdateHandler.py
,它将根据规则将 prompt.json
拆分为多种语言,并同步各语言的主页面代码以及精选提示词的独立页面代码。
部署说明
Deploy With Vercel
点击下方按钮,一键将 ChatGPT-Shortcut 部署到 Vercel 平台:
通过 Vercel,你可以快速将项目托管,并且可以自动处理构建和部署,适合没有复杂服务器配置需求的用户。
本地部署
确保你已安装 Node.js。
# Installation
yarn
# Local Development
yarn start
# Build: This command generates static content into the `build` directory
yarn build
# Update the `defaultLocale` in the `docusaurus.config.js` file, then perform a build for the desired language.
yarn build --locale zh
yarn build --locale en
yarn build --locale ja
yarn build --locale ko
yarn build --locale es
yarn build --locale fr
yarn build --locale de
yarn build --locale it
yarn build --locale ru
yarn build --locale pt
yarn build --locale hi
yarn build --locale ar
yarn build --locale bn
# Deploy for multiple languages
yarn build --locale zh && yarn build --locale en
Docker 部署
如果你熟悉 Docker,可以通过以下命令快速部署:
# ghcr.io
docker run -d -p 3000:3000 --name chatgpt-shortcut ghcr.io/rockbenben/chatgpt-shortcut:latest
# docker hub
docker run -d -p 3000:3000 --name chatgpt-shortcut rockben/chatgpt-shortcut:latest
或者,你也可以使用 docker-compose
:
version: "3.8"
services:
docsify:
container_name: chatgpt-shortcut
image: ghcr.io/rockbenben/chatgpt-shortcut:latest
ports:
- "3000:3000"
restart: unless-stopped
开启同步更新
如果你在 Vercel 上一键部署了自己的项目,可能会遇到一个问题,即总是提示存在更新。这是因为 Vercel 会默认为你创建一个新项目,而不是 fork 本项目,导致无法正确检测更新。建议按照以下步骤重新部署:
- 删除原先的仓库;
- 使用页面右上角的 fork 按钮,fork 本项目;
- 在 Vercel 新项目页面 的 Import Git Repository 处重新选择刚刚 fork 的项目并部署。
打开自动更新
如果遇到 Upstream Sync 执行错误,请手动执行一次 Sync Fork!
当你 fork 项目之后,由于 GitHub 的限制,需要手动在你 fork 后的项目的 Actions 页面启用 Workflows,并启用 Upstream Sync Action。启用后,每天会自动执行更新:
手动更新代码
如果想手动立即更新,可以查看 GitHub 的文档,了解如何让 fork 的项目与上游代码同步。
你可以给本项目点赞(star)/关注(watch),或者关注作者,以便及时获得新功能更新通知。