使用指南
前置条件
开始使用 ShipSaaS 之前的环境与工具准备。
前置条件
为确保你能顺利使用 ShipSaaS 开发项目,请确保完成以下前置要求。
网络环境畅通
请确保你的网络环境可以正常访问 Github、Google 等第三方服务。
可以在终端执行以下命令,查看你的网络出口 IP:
curl https://ipinfo.io
通过以下命令测试网络连通性:
curl https://google.com
如果网络环境不佳,可能会导致无法正常安装项目必须的 npm 依赖,无法连接云数据库、无法使用 AI 生成图片等功能。
搭建本地开发环境
请根据你的操作系统,搭建本地开发环境,安装必要的开发工具。以 Mac OS 为例:
安装 fnm 进行 Node.js 版本管理
推荐使用以下或更高版本的 Node.js 和 npm:
$ node -v
v22.2.0
$ npm -v
10.7.0
安装 pnpm 进行包管理
全局安装 pnpm:
$ npm install -g pnpm
推荐使用以下或更高版本的 pnpm:
$ pnpm -v
9.15.0
安装 git 进行版本管理
推荐使用以下或更高版本的 git:
$ git --version
git version 2.39.3 (Apple Git-146)
配置 SSH key
确保能访问你的 GitHub 仓库:
$ ssh -T [email protected]
AI 辅助编程工具
为了更好地理解 ShipSaaS 框架,更高效地开发项目,推荐使用以下 AI 工具辅助开发:
| Name | Description |
|---|---|
| Cursor | AI 编辑器 |
| Antigravity | AI 编辑器 |
| Claude Code | AI 编程命令行工具 |
| CodeX | AI 编程命令行工具 |
在 AI 编辑器中安装以下插件,可以更好地辅助开发:
- REST Client:接口调试
- Prettier - Code formatter:代码格式化