October DealsAmazon USOctober deal check: compare before you payAmazon US: current deals, useful picks and tech finds.Check DealsWindows FixRecommendedWindows errors stealing your time? Find the fix fastScan stability, cleanup and performance issues.Fix NowOctober DealsAmazon USDeal season is back - check today's better picksAmazon US: current deals, useful picks and tech finds.See Picks×
Skip to content
World desk5 min

How to Use BackstopJS with a Local Development Server

Start your app separately, point a BackstopJS scenario at its actual local URL, and use reference, test, and approve carefully to manage visual changes.

Free tools Windows power users keep installed

One-click scans. No signup required.

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.

Start your app’s development server, point a BackstopJS scenario at the exact local URL it serves, then capture a baseline with backstop reference. After changing the app, run backstop test to compare screenshots. BackstopJS visits URLs; it does not start your server for you. The steps below cover local setup, page readiness, Docker, and common failures.

Install and initialize BackstopJS

  1. From your project directory, install BackstopJS locally with npm install backstopjs. A local install makes it available to project scripts and integrations. If BackstopJS is already installed globally, you can use that installation instead. BackstopJS npm documentation
  2. Check your working tree and any existing BackstopJS configuration before initializing. Then, if the project does not already have a setup, run npx backstop init from the project directory. Initialization can overwrite existing files, so do not run it blindly over a configuration you need to preserve. The documented command is backstop init; use the invocation appropriate to your local or global installation.

You can expose the workflow through npm scripts. These names are examples; use names that fit your project:

{
  "scripts": {
    "visual:init": "backstop init",
    "visual:reference": "backstop reference",
    "visual:test": "backstop test",
    "visual:approve": "backstop approve"
  }
}

Start the server and set the scenario URL

Start the development server with the command your application uses. BackstopJS does not prescribe a universal start command or port: use the URL actually shown by your app, including its scheme, hostname, and port. For example, set http://localhost:3000/ only if the app is listening there.

In backstop.json, give the scenario a descriptive label and set its url to the local page you want to capture. Use referenceUrl if the baseline should come from a different environment or address. A simple scenario has this shape:

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.
#1 Best Overall
Elebase USB to USB C Adapter for iPhone 18 Pro Max,USBC Car Charger Adapter
  • Read Before You Buy — No Video Output: These adapters support charging and USB 2.0 data transfer, but cannot transmit video signals. Except for standard USB webcams (which use USB data only), they are not compatible with HDMI/DisplayPort cables, video-capable USB-C hubs, or docking stations with video output.
  • Convert USB-A Ports to USB-C: Designed to connect USB-C earphones, cables, flash drives, card readers, and other USB-C accessories to standard USB-A ports. Plug-and-play with no drivers or software required.
  • Aluminum Alloy Housing: Built with a sturdy aluminum alloy shell that aids in heat dissipation and protects against daily wear and scratches. Designed to maintain a stable and secure connection.
  • Compact & Travel-Friendly: The ultra-compact design allows the adapter to stay plugged into your device without blocking adjacent ports or adding bulk, reducing wear and tear on your original USB ports.
  • 12-Month Warranty: Backed by a 12-month manufacturer warranty for peace of mind. Designed to meet strict quality control standards for reliable everyday performance.
{
  "scenarios": [
    {
      "label": "Local home page",
      "url": "http://localhost:3000/"
    }
  ]
}

Replace the example address with your app’s real URL. If your reference is also local, point referenceUrl at the appropriate local or other reference page according to your test design. Scenario and configuration options are documented in the BackstopJS package documentation.

Capture, compare, and approve screenshots

  1. With the app reachable, run npx backstop reference to capture baseline screenshots.
  2. Make the code or style change you want to evaluate, then run npx backstop test. BackstopJS captures the configured scenarios and compares them with the stored references.
  3. Review the report and decide whether each visual difference is expected. Run npx backstop approve only when you intend to replace the baseline with the latest test images.

Keep the browser choice, viewport, URL, page data, interactions, selectors, and mismatch settings consistent between runs. Otherwise, a screenshot difference may reflect changed capture conditions rather than a change you meant to test. BackstopJS README

Rank #2
Anker USB-C Hub, 5-in-1 USB Hub for Laptops, 4K HDMI Multiport Adapter
  • 5-in-1 USB-C Hub: Experience comprehensive connectivity featuring a Power Delivery input, two USB-A 2.0 ports, a USB-A 3.0 port, and an HDMI port. (Note: The USB-C power delivery input port is only for connecting an external wall charger to power your laptop and cannot power peripheral devices.)
  • 90W Pass-Through Charging: Achieve optimal charging with 90W pass-through power to your laptop, supported by a total input of 100W, with the hub reserving 10W for operational efficiency. (Note: Wall charger not included.)
  • Quick Data Transfers: Accelerate your productivity with rapid data transfers using a high-speed 5Gbps USB 3.0 port and two 480Mbps USB 2.0 ports.
  • 4K HDMI Display: Enhance your visual experience with a hub capable of delivering 4K resolution at 30Hz in both mirror and extend modes. Please note that this hub is compatible with MacBook (macOS 12 and newer), Windows 10 and 11, ChromeOS, and laptops equipped with DP Alt Mode and Power Delivery. Note: This device is not compatible with Linux.
  • What You Get: Anker USB-C Hub (5-in-1, 4K HDMI), welcome guide, 18-month warranty, and our friendly customer service.

Make captures wait for the page to be ready

A server responding to a request does not necessarily mean the UI is ready for a useful screenshot. BackstopJS provides readiness controls including readySelector, readyEvent, readyTimeout, and delay. The documented default for readyTimeout is 30,000 ms. BackstopJS README

  • readySelector: wait for an element that appears only after the content you care about is ready.
  • readyEvent: wait for an application event. The BackstopJS example uses the event name backstopjs_ready; your app must emit it after its dependencies and relevant content are ready.
  • delay: add a fixed wait after readiness conditions have been met. This can help with late visual updates, but a longer delay is not a substitute for a reliable readiness signal.

Where timestamps, random values, rotating promotions, or other changing data create noise, use known static content or representative stubs when appropriate. For state setup and interactions, onBeforeScript can prepare browser state such as cookies, while onReadyScript can perform UI interactions after readiness conditions are fulfilled. A scenario-level setting can override a global setting, so check scenario values if an inherited selector or other default seems to be ignored. BackstopJS README

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.
Rank #3
Sale
Anker USB C Hub, 7in1 Multi-Port USB Adapter, 4K@60Hz USBC to HDMI Splitter
  • Sleek 7-in-1 USB-C Hub: Features an HDMI port, two USB-A 3.0 ports, and a USB-C data port, each providing 5Gbps transfer speeds. It also includes a USB-C PD input port for charging up to 100W and dual SD and TF card slots, all in a compact design.
  • Flawless 4K@60Hz Video with HDMI: Delivers exceptional clarity and smoothness with its 4K@60Hz HDMI port, making it ideal for high-definition presentations and entertainment. (Note: Only the HDMI port supports video projection; the USB-C port is for data transfer only.)
  • Double Up on Efficiency: The two USB-A 3.0 ports and a USB-C port support a fast 5Gbps data rate, significantly boosting your transfer speeds and improving productivity.
  • Fast and Reliable 85W Charging: Offers high-capacity, speedy charging for laptops up to 85W, so you spend less time tethered to an outlet and more time being productive.
  • What You Get: Anker USB-C Hub (7-in-1), welcome guide, 18-month warranty, and our friendly customer service.

Use the right hostname with Docker

If you run BackstopJS with --docker, the browser runs inside a container. In that setup, localhost refers to the container rather than your host machine, so it will not reach a development server running on the host by using the ordinary host-local address. The BackstopJS documentation gives host.docker.internal as an example for Mac and Windows. Use a hostname supported by your Docker host environment, and change the URL only for the Docker case; ordinary non-Docker local runs should keep using the address your app serves. BackstopJS README

Troubleshoot common local-server failures

Symptom Likely cause What to check or change
BackstopJS cannot load the scenario URL The server is not running, or the scenario has the wrong scheme, host, port, or path. Start the app separately and open the exact configured URL. Verify the actual port and route instead of assuming the example port.
localhost works in a browser but not under --docker The capture browser is inside a container, where localhost points to that container. Use a host-access hostname supported by your Docker setup, such as the documented host.docker.internal example for Mac and Windows.
The screenshot is blank, incomplete, or inconsistent The capture may happen before the relevant UI or dependencies are ready. Set a meaningful readySelector or emit the configured readyEvent only after the page state is ready. Use delay for a known late update when needed, and check the readiness timeout.
Every run reports unrelated visual changes Dynamic content or changed capture conditions may be affecting the comparison. Stabilize changing data where practical, and keep viewport, browser, selectors, interactions, URL, and state consistent.
A readiness setting appears to have no effect A scenario-level value may override the global configuration. Inspect the scenario and global settings together; remove or correct a scenario override that clears the intended inherited value.
A new baseline was created unexpectedly backstop approve updates the reference screenshots to the latest test images. Review differences before approving. Use the existing reference/test flow for comparison and approve only intentional changes.
Initialization replaced a file backstop init may overwrite existing files. Check the working tree and existing configuration before initialization; restore or recover a needed file from version control if it was replaced.
Independent reader supportYour contribution helps us test, update, and keep practical guides available for everyone.Support on Ko-Fi

Or skip the browser setup

If you need a screenshot of a page rather than a repeatable local visual-regression baseline, ScreenshotNeo offers a one-request screenshot API. It is not a replacement for BackstopJS’s reference-and-compare workflow. The request below captures a public page as WebP; see the ScreenshotNeo API documentation for options.

Rank #4
Sale
UGREEN USB to USB C Adapter Combo 4-Pack, 10Gbps USB C Converter Space Gray
  • Dual Converters, Infinite Potential:Includes 2× USB C male to USB A female adapters and 2× USB A male to USB C female adapters. Perfect for a wide range of uses—tablets with Bluetooth keyboards, expand USB ports on macbook, and more. Two different converters for all your daily needs
  • Next-Level 10Gbps & 3A Charging: No more slow 480Mbps, this usb to usb c adapter has a transfer speed of up to 10Gbps, allowing you to do more transferring in less time. This usb adapter fits both USB A and USB C charger, supporting up to 3A fast charging
  • Upgraded Exquisite Craftsmanship: With an aluminum alloy housing and metal connector, the usbc to usb adapter is extremely durable and sturdy. Rigorously tested to withstand more than 10,000 times of plugging and unplugging, ensuring long-lasting performance
  • Broad Compatible: The usb c to usb adapter widely supports all USB C/ USB A devices like laptops, tablets, cellphones, car chargers, and phone chargers. Such as compatible with MacBook Pro/Air 2023/2022, Thunderbolt 4/3 Devices,Apple MagSafe Watch 9/8/7/SE/Ultra, iPad Pro 2022/2021, Samsung Galaxy S23/S20/S10, and iPhone 17/16/15 Pro. Plug and play
  • Please Note: To reach 10Gbps speed, keep the cable under 3.3 ft. For USB A Male to USB C adapters, try flipping the USB C connector. USB C Male to USB A adapters support bidirectional 10Gbps transfer within 3.3 ft
curl -G "https://api.screenshotneo.com/v1/shot" -d access_key=YOUR_API_KEY --data-urlencode url=https://stripe.com -o shot.webp

ScreenshotNeo removes cookie banners, newsletter popups, and chat widgets before capture. Bot checks, blank pages, failed loads, timeouts, and cache hits are not billed. Its MCP server lets AI agents take screenshots, and the free plan includes 1,000 screenshots per month without a card; paid plans start at $5 for 3,000. Sign up for 1,000 free screenshots a month with no card.

Frequently Asked Questions

Does BackstopJS start my local development server?

No. Start the app yourself or use your own project orchestration; BackstopJS visits the scenario URL you configure.

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.

What does `backstop approve` do?

It replaces the reference screenshots with the latest test images, so use it only after reviewing and accepting the visual changes.

Best Value
Anker USB C Hub, 5-in-1 USBC to HDMI Splitter with 4K Display
  • 5-in-1 Connectivity: Equipped with a 4K HDMI port, a 5 Gbps USB-C data port, two 5 Gbps USB-A ports, and a USB C 100W PD-IN port. Note: The USB C 100W PD-IN port supports only charging and does not support data transfer devices such as headphones or speakers.
  • Powerful Pass-Through Charging: Supports up to 85W pass-through charging so you can power up your laptop while you use the hub. Note: Pass-through charging requires a charger (not included). Note: To achieve full power for iPad, we recommend using a 45W wall charger.
  • Transfer Files in Seconds: Move files to and from your laptop at speeds of up to 5 Gbps via the USB-C and USB-A data ports. Note: The USB C 5Gbps Data port does not support video output.
  • HD Display: Connect to the HDMI port to stream or mirror content to an external monitor in resolutions of up to 4K@30Hz. Note: The USB-C ports do not support video output.
  • What You Get: Anker 332 USB-C Hub (5-in-1), welcome guide, our worry-free 18-month warranty, and friendly customer service.

Product prices and availability are accurate as of the date/time indicated and are subject to change. Any price and availability information displayed on Amazon at the time of purchase will apply.

Leave a Reply

Your email address will not be published. Required fields are marked *

What’s actually slowing this PC down?

Pick the symptom - the matching free tool is one click away.

Special offer. See more information about Outbyte and uninstall instructions. Please review EULA and Privacy policy.

More from the Wire

  1. Shenzhen desk3 min
    HONOR Expands Beyond Smartphones With Humanoid Robot RevealHONOR said it unveiled its first humanoid robot at MWC 2026 and named shopping assistance, workplace inspections, and supportive companionship as intended uses. Later Robotics D1 claims and a reported…
  2. Cupertino desk5 min
    Apple Unveils AirPods Max 2: The Upgrade That Should Have Happened Years AgoAirPods Max 2 adds H2-powered audio features and Apple claims up to 1.5× more effective ANC, but its design, Smart Case, and 20-hour battery rating are unchanged. Wired lossless audio…
  3. Cupertino desk4 min
    Apple’s OLED Touch MacBooks Are Coming—but the Dynamic Island Is the Real GambleApple has not announced an OLED touchscreen MacBook, but reports point to high-end models arriving in late 2026 or early 2027. The reported Mac Dynamic Island could be useful, but…
Recommended PC Tool
Recommended PC Tool
Windows Errors? Fix Them Before They SpreadFree repair scan
Crashes, No Sound, or Screen Glitches?Free driver scan

Two free Windows tools

One Free Minute Could Fix That PC

Before you go - each of these free tools takes about a minute and tackles what quietly slows a Windows PC down.

Special offer. View Outbyte info, uninstall instructions, EULA, and Privacy Policy.