Installation Guide

This guide walks you through installing and configuring PeerScripts for your Shopify store.

---

Step 1: Install from Shopify App Store

1. Visit the PeerScripts listing on the Shopify App Store
2. Click Add app
3. Review the requested permissions
4. Click Install app

Required Permissions

PeerScripts requests access to the following areas of your store:

Permission	Purpose
Read themes	Analyze theme code for issues
Read products	Catalog intelligence and quality audits
Read orders	Store health monitoring and anomaly detection
Read discounts	Discount intelligence and usage tracking
Read installed apps	App intelligence and risk assessment
Write themes	Code editor functionality (optional)

All data access is read-only unless you explicitly use write features like the code editor.

---

Step 2: OAuth Authorization

After clicking install, you'll be redirected to authorize PeerScripts:

1. Review the list of permissions
2. Confirm you want to grant access
3. Click Install app

You'll be redirected back to PeerScripts within your Shopify admin.

---

Step 3: Initial Configuration

Upon first launch, PeerScripts will guide you through initial setup:

AI Configuration

Choose your preferred AI model for analysis features:

Model	Speed	Detail	Recommended For
GPT-4o	Fast	High	General use (recommended)
GPT-4o Mini	Fastest	Medium	High-volume stores
GPT-4 Turbo	Moderate	Highest	Complex analysis needs

Confirmation Settings

Configure how PeerScripts handles potentially impactful operations:

• Auto-suggest: Enable AI suggestions for issue resolution
• Confirmation required: Require approval before executing bulk actions

Team Access

Add team members who should have access to PeerScripts:

1. Navigate to Settings > Team
2. Click Add Member
3. Enter their Shopify staff email
4. Select their permission level

---

Step 4: Initial Data Sync

PeerScripts begins syncing your store data immediately after installation:

What Gets Synced

Data Type	Initial Sync	Ongoing Sync
Theme files	All themes	On change detection
Products	Full catalog	On product changes
Orders	Last 90 days	Real-time via webhooks
Discounts	All active codes	On code changes
Installed apps	All apps	Periodic refresh

Sync Progress

The dashboard displays sync progress for each data type. Initial sync duration depends on your store size:

• Small stores (< 1,000 products): 1-5 minutes
• Medium stores (1,000-10,000 products): 5-15 minutes
• Large stores (> 10,000 products): 15-30 minutes

---

Step 5: Run Initial Scans

With data synced, run your first scans to establish baselines:

Theme Intelligence Scan

1. Navigate to Theme Intelligence
2. Select your live theme
3. Click New Scan > Full Scan
4. Wait for analysis to complete (typically 2-5 minutes)

Quality Audit

1. Navigate to Quality
2. Click Run Audit
3. Review detected issues by severity

Lighthouse Performance

1. Navigate to Lighthouse
2. Click New Scan
3. Select device type (Mobile recommended)
4. Review Core Web Vitals scores

---

Step 6: Establish Health Baseline

Store Health monitoring requires 7 days of data to establish baselines:

During the Baseline Period

• PeerScripts collects daily metrics
• No anomaly alerts will fire yet
• You can still view raw metrics

After 7 Days

• Anomaly detection becomes active
• You'll receive alerts for significant deviations
• Historical comparisons become available

---

Webhook Configuration

PeerScripts automatically registers webhooks for real-time updates:

Webhook	Purpose
orders/create	Track new orders
orders/updated	Monitor order changes
products/update	Detect product modifications
themes/update	Track theme changes
app/uninstalled	Clean up on uninstall

No manual configuration is required.

---

Verifying Installation

Confirm PeerScripts is correctly installed:

1. Dashboard loads: You see the main dashboard with widgets
2. Data appears: Store metrics begin populating
3. Scans work: Theme and quality scans complete successfully
4. Settings accessible: You can access and modify settings

---

Troubleshooting Installation

App Won't Install

• Ensure you have store owner or admin access
• Check that your store is on a supported Shopify plan
• Try clearing browser cache and cookies

Data Not Syncing

• Wait a few minutes for initial sync
• Check your internet connection
• Try clicking "Sync" manually in the affected section

Scans Failing

• Ensure your theme uses standard Liquid syntax
• Check for very large theme files (> 1MB)
• Contact support if issues persist

---

Next Steps

With PeerScripts installed, continue to:

1. Quick Start Guide - Learn the essentials
2. Dashboard Overview - Understand your metrics
3. Feature Documentation - Explore all capabilities

---

Uninstalling PeerScripts

If you need to uninstall:

1. Go to Shopify Admin > Apps
2. Find PeerScripts
3. Click Delete (or the trash icon)
4. Confirm uninstallation

All PeerScripts data is retained for 30 days in case you reinstall.