Installation Process

Congratulations on purchasing ShipReady! This guide will walk you through the process of setting up your ShipReady project, from accepting the GitHub invitation to running the app locally.

1. Accept GitHub Invitation

After your purchase, you'll receive an email invitation to access the ShipReady GitHub repository.

1. Check your email for an invitation from GitHub.
2. Click on the invitation link in the email.
3. If prompted, sign in to your GitHub account or create one.
4. Click "Accept invitation" to gain access to the repository.

2. Clone the Repository

Once you have access to the repository, you'll need to clone it to your local machine.

1. Open your terminal or command prompt.
2. Navigate to the directory where you want to store the project.
3. Run the following command:

git clone https://github.com/Hujjat/ShipReady.git shipready-app
cd shipready-app

3. Install Dependencies

Now that you have the project files, you need to install the necessary dependencies.

1. Ensure you have Node.js and npm (or yarn) installed.
2. In the project directory, run:

npm install
# or
yarn install

4. Set Up Environment Variables and Scopes

ShipReady requires some environment variables to be set for proper functionality.

1. In the project root, copy the .env.example file and rename it to .env.
2. Open the .env file and fill in the required values:

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

Replace the placeholders with your actual Shopify app credentials and host URL.

3. Open the [shopify].app.toml file and add the required scopes:

scopes = "write_metaobject_definitions,write_metaobjects,write_products,write_themes"

5. Start the Development Server

With everything set up, you can now start the development server.

1. Run the following command:

npm run dev
# or
yarn dev

6. Verify Installation

Ensure everything is working correctly:

1. Navigate through your app in the Shopify admin.
2. Check the console for any errors.
3. Try a basic functionality like creating a product or accessing store data.

7. Database seeding (Optional)

If you want to seed the database with some sample data, you can run the following command:

npm run prisma db seed

Next Steps

Congratulations! You've successfully installed and set up ShipReady. Here are some next steps:

• Review the Quick Start Guide to learn how to use ShipReady's features.
• Explore the Core Functionalities documentation to understand the app's capabilities.

If you encounter any issues during the installation process, please refer to our Troubleshooting page or contact our support team.