ShipSaaS Docs
Usage Guide

Prerequisites

Prepare your environment and tools before using ShipAny.

Prerequisites

To ensure a smooth development experience with ShipAny, complete the following prerequisites.

Ensure network access

Make sure your network can reach third-party services like GitHub and Google.

Check your outbound IP:

curl https://ipinfo.io

Test connectivity:

curl https://google.com

Poor connectivity may prevent npm dependencies from installing, cloud databases from connecting, or AI image generation from working properly.

Set up a local development environment

Set up the required tools for your OS. The example below uses macOS.

Install fnm for Node.js version management

Recommended versions (or higher):

$ node -v
v22.2.0
$ npm -v
10.7.0

Install pnpm for package management

Install pnpm globally:

$ npm install -g pnpm

Recommended pnpm version (or higher):

$ pnpm -v
9.15.0

Install git for version control

Recommended git version (or higher):

$ git --version
git version 2.39.3 (Apple Git-146)

Configure your SSH key

Ensure you can access your GitHub repositories:

$ ssh -T [email protected]

AI-assisted development tools

To better understand the ShipAny framework and improve development efficiency, we recommend these AI tools:

NameDescription
CursorAI editor
AntigravityAI editor
Claude CodeAI CLI tool
CodeXAI CLI tool

Install these editor plugins for a better experience:

  • REST Client: API debugging
  • Prettier - Code formatter: code formatting