Getting Started
System Requirements

System Requirements

To use ShipReady effectively, ensure your development environment meets the following requirements:

Node.js

  • Version: 16.x or later (LTS version recommended)
  • Why: ShipReady is built on Shopify Remix, which requires Node.js to run.

You can check your Node.js version by running:

node --version

npm or yarn

  • Version:
    • npm: 7.x or later
    • yarn: 1.22.x or later
  • Why: These package managers are used to install and manage project dependencies.

Check your package manager version:

npm --version
# or
yarn --version

Git

  • Version: 2.x or later
  • Why: Git is used for version control and to clone the ShipReady repository.

Verify your Git installation:

git --version

Additional Software

  • Code Editor: We recommend Visual Studio Code with the Shopify Remix extension for the best development experience.
  • Browser: Latest versions of Chrome, Firefox, or Safari for testing your Shopify apps.

Shopify Requirements

  • Shopify Partner Account: Required for creating and managing Shopify apps.
  • Shopify CLI: Version 3.x or later, for local app development and deployment.
  • Shopify Development Store: For testing your app in a Shopify environment.

Shopify Remix Knowledge

While not a system requirement, familiarity with the following will be beneficial:

  • Remix framework concepts
  • React.js
  • Shopify's Polaris design system
  • GraphQL for Shopify API interactions

We recommend you to watch our free videos for Shopify app development with Remix (opens in a new tab)

Next Steps

Once you've confirmed your system meets these requirements, you're ready to install ShipReady.

If you encounter any issues with your setup, please refer to our troubleshooting guide or contact our support team.