Ship 文档:快速开始、部署与更新
从 Ship 模板到上线产品:获取仓库、本地启动、部署网站、发布桌面端,以及同步模板更新。
获取仓库访问
- 在价格页订阅,并在 账户 → 模板访问 填写 GitHub 用户名。
- 访问开放后你会收到 GitHub 只读邀请,请在 7 天内接受;过期会自动重发。
- 用模板建自己的私有仓库:克隆下来,推到你自己的新仓库(把模板保留为 upstream 远程)。
git clone git@github.com:okayok-ai/ship-tanstack.git my-site
cd my-site
git remote rename origin upstream
git remote add origin git@github.com:<you>/my-site.git
git push -u origin main快速开始:Ship TanStack
- 用 pnpm 安装依赖。
- 把 .env.example 复制为 .env.development,填数据库、登录和 Stripe 配置。
- 推送表结构并启动开发服务器。
- 改 src/lib/seo/site.ts、messages/*.json 和 logo 完成换品牌,再用脚本重新生成分享图。
pnpm install
cp .env.example .env.development
pnpm db:push
pnpm dev快速开始:Ship Electron
- 在 app.config.json 里填产品名、协议名和域名,运行改名脚本。
- 安装根目录和 renderer 的依赖,以开发模式启动。
- 把登录指向你网站的后端,并在 OAuth 服务商登记应用协议回调地址。
npm install
(cd renderer && npm install)
npm run dev部署与发布
- 网站:建 Vercel 项目,配好生产环境变量,把 VERCEL_TOKEN / VERCEL_ORG_ID / VERCEL_PROJECT_ID 设为仓库 secrets。只有打 v 开头的标签才部署生产。
- 桌面端:配好签名与公证 secrets,推 desktop-v 开头的标签;CI 自动构建、签名、公证并发布安装包和更新描述文件。
- 不要强推共享分支;发布流程是提交、推 main、再推带注释的标签。
git tag -a v0.1.0 -m "v0.1.0"
git push origin v0.1.0同步模板更新
- 订阅期间,从模板远程拉取并合并需要的改动。
- 每次模板更新都会记录在更新日志里。
git fetch upstream
git merge upstream/main