Getting Started

Quick Start Guide

Get productive with PeerScripts in under 10 minutes. This guide covers the essential workflows you'll use most often.

Quick Start Guide

Get productive with PeerScripts in under 10 minutes. This guide covers the essential workflows you'll use most often.


The 5-Minute Tour

Your Dashboard

The dashboard is your command center. Here's what you'll see:

┌─────────────────────────────────────────────────────────────────┐
│                        STORE HEALTH                             │
│  ┌──────────┐ ┌──────────┐ ┌──────────┐ ┌──────────┐           │
│  │  Orders  │ │Fulfillment│ │  Refund  │ │ Revenue  │           │
│  │   142    │ │   94.2%  │ │   2.1%   │ │ $24,580  │           │
│  └──────────┘ └──────────┘ └──────────┘ └──────────┘           │
├─────────────────────────────────────────────────────────────────┤
│ DETECTION SYSTEMS                  │ ATTENTION REQUIRED        │
│ ☑ Theme Intelligence    12 issues │ ⚠ 3 High Priority Items   │
│ ☑ Quality Audits         8 issues │ • SEO meta missing (5)    │
│ ☑ Lighthouse            Score: 72 │ • Theme security (2)      │
│ ☑ Catalog Intelligence   4 issues │ • Fulfillment drop        │
│ ☑ Store Health          Healthy   │                           │
└─────────────────────────────────────────────────────────────────┘

Key Metrics

  • Orders: Total orders in the selected period
  • Fulfillment Rate: Percentage of orders fulfilled on time
  • Refund Rate: Percentage of orders refunded
  • Revenue: Total revenue in the period

Detection System Status

Each system shows its status and issue count. Click any system to dive deeper.


Essential Workflow #1: Theme Analysis

Run a Theme Scan

  1. Click Theme Intelligence in the sidebar
  2. Select your live theme (or a development theme)
  3. Click New Scan
  4. Choose scan type:
    • Quick Scan: Fast check of critical issues
    • Full Scan: Comprehensive analysis (recommended for first scan)

Understanding Results

Scan results are organized by severity:

Severity Meaning Action
Critical Immediate attention required Fix ASAP
High Significant impact on performance/security Fix soon
Medium Best practice violations Plan to fix
Low Minor improvements Optional

Taking Action

For any issue:

  1. Click the issue to see details
  2. Review the Recommendation section
  3. Click Create Ticket to track the fix
  4. Or click Ignore if it's a false positive

Essential Workflow #2: Quality Audits

Run a Quality Audit

  1. Click Quality in the sidebar
  2. Click Run Audit
  3. Wait for the scan to complete

What Gets Checked

Category Examples
SEO Missing meta titles, descriptions too short, missing alt text
Content Spelling errors, lorem ipsum text, placeholder content
Accessibility Missing ARIA labels, low color contrast

Fixing Issues

For each issue:

  1. Click to expand details
  2. See the exact location (page, product, or theme file)
  3. Review the recommended fix
  4. Click through to edit directly in Shopify

Essential Workflow #3: Performance Monitoring

Run a Lighthouse Scan

  1. Click Lighthouse in the sidebar
  2. Click New Scan
  3. Select device: Mobile (recommended) or Desktop
  4. Wait for results

Understanding Scores

Score Range Rating Meaning
90-100 Excellent No action needed
50-89 Needs Improvement Review recommendations
0-49 Poor Prioritize fixes

Core Web Vitals

Metric Good Needs Work Poor
LCP (Largest Contentful Paint) < 2.5s 2.5-4s > 4s
CLS (Cumulative Layout Shift) < 0.1 0.1-0.25 > 0.25
INP (Interaction to Next Paint) < 200ms 200-500ms > 500ms

Essential Workflow #4: Creating Tickets

Any issue detected by PeerScripts can become a ticket:

From an Issue

  1. View any issue detail page
  2. Click Create Ticket
  3. Edit title and description if needed
  4. Set priority and assignee
  5. Click Create

From Scratch

  1. Click Tickets in the sidebar
  2. Click New Ticket
  3. Fill in details:
    • Title: Brief description
    • Description: Full details
    • Priority: Low, Medium, High, Critical
    • Assignee: Team member (optional)
    • Due Date: Target completion date

Using the Kanban Board

Drag tickets between columns to update status:

┌───────────┐  ┌───────────┐  ┌───────────┐  ┌───────────┐
│  BACKLOG  │  │    TODO   │  │ IN PROGRESS│  │   DONE   │
├───────────┤  ├───────────┤  ├───────────┤  ├───────────┤
│ • Ticket 1│──│ • Ticket 4│──│ • Ticket 6│──│ • Ticket 8│
│ • Ticket 2│  │ • Ticket 5│  │ • Ticket 7│  │ • Ticket 9│
│ • Ticket 3│  │           │  │           │  │           │
└───────────┘  └───────────┘  └───────────┘  └───────────┘

Essential Workflow #5: Store Health Monitoring

Daily Check-In

  1. Visit the Dashboard or Store Health section
  2. Review the key metrics
  3. Check for any new Attention Items

Responding to Alerts

When PeerScripts detects an anomaly:

  1. You'll see it in the Attention Required section
  2. Click to view details
  3. Review the Analysis explaining what happened
  4. Check Correlations to see if recent changes might be related
  5. Take action or dismiss if expected

Quick Tips

Keyboard Shortcuts

Shortcut Action
G then D Go to Dashboard
G then T Go to Tickets
G then S Go to Settings
/ Open search

Time Savers

  • Bulk Actions: Select multiple issues and create tickets or ignore in bulk
  • Filters: Use severity and type filters to focus on what matters
  • Exports: Export any scan or report as CSV or PDF
  • Notifications: Set up email alerts for critical issues

Best Practices

  1. Run weekly scans: Schedule theme and quality scans weekly
  2. Monitor Lighthouse: Track Core Web Vitals monthly at minimum
  3. Review changes: Check the Changes section after any major update
  4. Use tickets: Track all fixes through the ticket system
  5. Establish baselines: Let the 7-day baseline complete for accurate alerts

What's Next?

Now that you know the essentials:

  1. Explore Features: Check out the full feature documentation
  2. Customize Settings: Configure AI models and team access in Settings
  3. Set Up Sprints: Learn about sprint planning
  4. Use the API: Integrate with your tools via the API Reference

Need Help?