Quick Start Guide

Quick Start Guide

Welcome to ShipReady! This guide will help you set up and create your first Shopify app using ShipReady.

Prerequisites

Before you begin, ensure you have:

  • Node.js (version 16.x or later) installed
  • A Shopify Partner account
  • Basic knowledge of React and GraphQL

Video Tutorial

If you prefer video tutorials, you can watch the following video to learn how to create your first Shopify app using ShipReady.

Step 1: Installation

  1. Clone the ShipReady repository
git clone https://github.com/Hujjat/ShipReady my-first-app
cd my-first-app
  1. Install dependencies:
npm install
  1. Set environment variables: duplicate the .env.example file and rename it to .env. Fill in the required values. DB_URL is required for postgresql database connection. You can use any postgresql database url.

Here is an example of the .env file:

TESTMODE=true
APP_NAME=ShipReady
APP_HANDLE=shipready-app-handle
DB_URL=postgres://postgres:[email protected]:5432/shipready-db

DBngin (opens in a new tab) is a great tool to create a local postgresql database.

  1. Before running the app, you need to add the required scopes for your app. To do this, open the [shopify].app.toml file and add the required scopes.

ShipReady requires the following scopes but you can add more scopes if you need them.

scopes = "write_metaobject_definitions,write_metaobjects,write_products,write_themes"

Step 2: Run the app

npm run dev

Now, press

Step 3: Customize the app

You're now ready to customize the app. You can modify the app's code in the app directory.

Next Steps

Congratulations! You've created your first Shopify app with ShipReady. Here are some next steps:

For more detailed information, check out our full documentation. If you encounter any issues, visit our troubleshooting guide or contact support.

Happy developing with ShipReady!

HomeSystem Requirements