Prerequisites

To ensure you can successfully use ShipAny to develop your project, please make sure you have completed the following prerequisites.

Network Environment

Please ensure your network environment can normally access third-party services such as Github and Google.

You can execute the following command in the terminal to check your network exit IP:

curl https://ipinfo.io

Test network connectivity with the following command:

curl https://google.com

If the network environment is poor, it may cause issues such as inability to install required npm dependencies, inability to connect to cloud databases, and inability to use AI image generation features.

Set Up Local Development Environment

Please set up your local development environment and install necessary development tools according to your operating system. Using Mac OS as an example:

1. Install fnm for NodeJS version management

It is recommended to use the following or higher versions of NodeJS and npm:

$ node -v
v22.2.0

$ npm -v
10.7.0

2. Install pnpm for package management

Install pnpm globally:

$ npm install -g pnpm

It is recommended to use the following or higher version of pnpm:

$ pnpm -v
9.15.0

3. Install git for version control

It is recommended to use the following or higher version of git:

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

4. Configure ssh key to ensure you can access your Github repository

$ ssh -T git@github.com

AI-Assisted Programming Tools

To better understand the ShipAny framework and develop projects more efficiently, it is recommended to use the following AI tools to assist development:

Installing the following plugins in AI editors can better assist development:

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

Other Tools

• Use Nano Banana Pro to generate images
• Use v0 to generate UI components