LogoShipSaaS
使用指南

前置要求

在开始安装和运行 ShipSaaS 之前,请确保您的本地开发环境已满足以下要求

在开始设置 ShipSaaS 之前,您需要在本地开发机上安装以下基础软件。这些工具能够保证模板的顺利安装、本地运行以及向 Cloudflare 边缘网络的流畅部署。


网络环境要求

请确保您的网络环境可以正常访问 GitHub、Google 等第三方服务。

[!WARNING] 如果网络环境不佳,可能会导致无法正常安装项目必需的 npm 依赖、无法连接云端数据库,或者无法使用 AI 生成图片等功能。

1. 查看网络出口 IP

可以在终端执行以下命令,查看您的网络实际出口 IP:

curl https://ipinfo.io

2. 测试网络连通性

通过以下命令测试与外部网络的连通性:

curl -I https://google.com

1. Git (版本控制)

Git 是目前最主流的开源分布式版本控制系统,用于拉取模板和管理您自己的代码库。

您可以运行以下命令检查是否已安装:

git --version

如果尚未安装,请根据您的操作系统进行下载:

  • Windows: 从 Git 官方网站 下载安装包。
  • macOS: 可以在终端运行 xcode-select --install 或使用 Homebrew:brew install git
  • Linux: 使用系统的包管理器,例如 sudo apt install git

2. Node.js

Node.js 是允许在本地运行 JavaScript 和 TypeScript 应用程序的运行时环境。虽然我们使用 Bun,但部分周边生态工具仍依赖 Node.js 的兼容接口。

建议使用 Node.js LTS(长期支持版,目前为 v20 或更高版本)。

检查是否已安装及版本:

node --version

如果未安装,请前往 Node.js 官方网站 下载并安装。


3. Bun (推荐包管理器与运行时)

Bun 是一个超快速的 JavaScript 运行时、打包器、测试运行器和包管理器。它比 Node.js 快数倍,非常适合基于 NextJS 的全栈 (ShipStack) 项目。

[!IMPORTANT] ShipSaaS 完全支持并推荐使用 Bun 作为默认开发引擎。所有的日常运行、打包和数据库迁移命令都基于 Bun 运行。

检查是否已安装及版本:

bun --version

如果您尚未安装 Bun,可以通过以下单行命令在 macOS、Linux 以及 WSL (Windows Subsystem for Linux) 上进行极速安装:

curl -fsSL https://bun.sh/install | bash
  • Windows 用户(非 WSL)可以通过 Powershell 安装:
    powershell -c "irm bun.sh/install.ps1 | iex"

4. GitHub CLI (命令行工具)

GitHub CLI (gh) 是在终端与 GitHub 仓库直接交互的官方工具。在设置 CI/CD 和自动化部署同步生产环境变量时,它能极大地简化您的操作步骤。

检查是否已安装:

gh --version

如果未安装,可以使用包管理器进行安装:

  • macOS (Homebrew): brew install gh
  • Windows (Winget): winget install --id GitHub.cli
  • Linux (Debian/Ubuntu):
    sudo apt install gh

安装后,请进行登录授权:

gh auth login

按照终端提示进行浏览器授权登录即可。

On this page