Prerequisites

Before installing and running ShipSaaS, please ensure your local development environment meets the following requirements

Before you begin setting up ShipSaaS, you need to install the following baseline software on your local development machine. These tools ensure the smooth installation, local running, and deployment of the template to the Cloudflare edge network.

Network Environment Requirements

Please make sure your network environment can normally access GitHub, Google, and other third-party services.

[!WARNING] A poor network environment may result in failures to install required npm dependencies, connect to the cloud database, or use AI features such as image generation.

1. View Network Egress IP

You can execute the following command in the terminal to view your actual network egress IP:

curl https://ipinfo.io

2. Test Network Connectivity

Test the connectivity to external networks via the following command:

curl -I https://google.com

1. Git (Version Control)

Git is the most popular open-source distributed version control system used to pull the template and manage your own code repository.

You can run the following command to check if it's already installed:

git --version

If it is not installed, please download it according to your operating system:

Windows: Download the installer from the Official Git Website.
macOS: You can run xcode-select --install in the terminal or use Homebrew: brew install git.
Linux: Use your system's package manager, e.g., sudo apt install git.

2. Node.js

Node.js is a runtime environment that allows running JavaScript and TypeScript applications locally. Although we use Bun, some surrounding ecological tools still rely on Node.js compatibility interfaces.

We recommend using Node.js LTS (Long Term Support version, currently v20 or higher).

Check if it is installed and its version:

node --version

If not installed, please head to the Official Node.js Website to download and install.

3. Bun (Recommended Package Manager & Runtime)

Bun is an incredibly fast JavaScript runtime, bundler, test runner, and package manager. It is many times faster than Node.js, making it exceptionally suited for NextJS-based full-stack (ShipStack) projects.

[!IMPORTANT] ShipSaaS fully supports and recommends using Bun as the default development engine. All daily running, building, and database migration commands run based on Bun.

Check if it is installed and its version:

bun --version

If you have not installed Bun, you can do a rapid install on macOS, Linux, and WSL (Windows Subsystem for Linux) via the following one-line command:

curl -fsSL https://bun.sh/install | bash

Windows users (non-WSL) can install via Powershell:
```
powershell -c "irm bun.sh/install.ps1 | iex"
```

4. GitHub CLI (Command Line Tool)

GitHub CLI (gh) is the official tool for interacting directly with GitHub repositories in your terminal. It drastically simplifies steps when setting up CI/CD and automating production environment variables synchronization.

Check if it is installed:

gh --version

If not installed, you can install it using a package manager:

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

After installation, please authenticate by logging in:

gh auth login

Follow the terminal prompts to complete the browser authorization login.