To get started with Nightwatch.js, install Node.js, scaffold a project with npm init nightwatch, choose a local browser, and run the generated test with npx nightwatch ./nightwatch/examples. Nightwatch is a Node.js framework that automates browser tests through the W3C WebDriver API. This guide walks through a first local end-to-end test, what its assertions mean, and when to move testing to a remote browser service.
What you need before you start
- Node.js and npm: The Nightwatch getting-started guide has listed Node.js versions above v14.20 as supported, but minimum versions change. Check the current getting-started guide before choosing a runtime for a new project.
- A browser: For the simplest first run, install one desktop browser locally, such as Chrome. Nightwatch supports Chrome, Firefox, Safari, and Edge; driver compatibility and availability vary by browser and environment.
- A target: Use localhost or your development site’s URL so the test can visit a page you control.
Nightwatch’s documentation describes the workflow and configuration, but setup time depends on your Node.js, browser, driver, and operating-system versions.
Create a Nightwatch project
- Open a terminal in the directory where you want the project. To create a new project, move into a new or empty directory first. You can also run the initializer from an existing project.
- Run
npm init nightwatch. - Answer the setup wizard prompts. Choose end-to-end testing, a language and runner, one installed desktop browser, a test folder, your local base URL, and local execution for the first run.
- Let the wizard create the Nightwatch configuration and sample tests. The guide’s generated setup includes
nightwatch.conf.js; inspect it before changing defaults.
The wizard lets you make several choices at once, so keep the first configuration narrow: one browser and one development URL are easier to diagnose than a multi-browser or remote setup. For the official workflow, see Getting Started | Nightwatch.js.
Run the generated browser test
From the project root, run the generated example tests with:
Windows Errors? Fix Them Before They Spread
Repair common Windows errors and clear accumulated junk for a smoother, more stable PC - no reinstall needed.Free scan · no reinstallCrashes, No Sound, or Screen Glitches?
Random freezes, missing sound and display glitches usually trace back to one bad driver. Find and replace yours safely.Free scan · under a minute#1 Best Overall
- 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.
npx nightwatch ./nightwatch/examples
Nightwatch should launch the configured browser, execute the sample test, and print the results. The getting-started guide also shows an HTML report location in the command output; open the reported file in a browser to review the run. If the command cannot start a browser, check that the selected browser is installed and that your configuration uses a compatible driver.
Configure a local Chrome environment
For a direct local Chrome setup, Nightwatch documents installing both nightwatch and chromedriver, defining an environment with browserName: 'chrome', and selecting it with --env. A representative setup is:
Rank #2
- 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.
npm install --save-dev nightwatch chromedriver
In nightwatch.conf.js, define a local environment under the configuration’s test_settings:
module.exports = {
test_settings: {
'chrome-local': {
desiredCapabilities: {
browserName: 'chrome'
}
}
}
};Then run:
npx nightwatch --env chrome-local
Nightwatch environments let you keep environment-specific settings, such as the browser target, alongside shared defaults. Consult Define Test Environments and Webdriver Settings for the current configuration options, including driver process management with start_process and a driver server_path. The Chrome Driver guide covers ChromeDriver paths and Chrome capabilities. Follow current browser/driver compatibility instructions rather than assuming an old driver will work with a newly installed browser.
Recommended Free Tools
Rank #3
- 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.
Write a first meaningful test
A useful browser test checks a result that matters to a user, rather than merely proving that a page opened. A simple test might navigate to a page and verify its title, URL, visible text, or a form element’s value. Nightwatch supports selector-based element lookup and built-in assertions; its introduction to writing tests and assertions guide explain the available patterns.
For each test, make the action and expected outcome explicit: visit the relevant route, perform a user action if needed, then assert the visible result or state. Choose the assertion behavior deliberately:
Rank #4
- 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
assertstops the test when that check fails. Use it when later checks depend on the condition being true.verifyrecords a failed check but allows the remaining checks to continue. Use it when you want a run to report multiple independent problems.
Do not make a test depend on incidental content that changes often. Prefer stable, user-relevant outcomes and selectors that your application intends to keep stable.
Independent reader supportYour contribution helps us test, update, and keep practical guides available for everyone.Local testing or a remote browser grid?
| Approach | Best fit | What to plan for |
|---|---|---|
| Local browser | A first test, quick development feedback, or a small set of browsers on a developer machine. | Install and maintain the browser and compatible driver locally; configure the Nightwatch environment for that browser. |
| Remote grid or cloud browser service | Teams that need remote execution, broader browser/OS combinations, or distributed testing. | Provider-specific configuration and credentials; decide which browser/OS coverage and parallel execution needs justify the additional setup. Current provider pricing and plan limits are not established here. |
Nightwatch documents remote execution through Selenium Grid and cloud browser services, with configuration examples for BrowserStack, Sauce Labs, and TestingBot. Start locally unless you have a concrete need for broader coverage or remote execution. See Running Nightwatch on remote machines or cloud providers before configuring a provider. Keep credentials out of committed test configuration and follow the provider’s current instructions for supplying them.
Free tools Windows power users keep installed
One-click scans. No signup required.
Best Value
- 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.
Troubleshoot common first-run problems
- The initializer or command cannot find Node/npm: Install Node.js, open a new terminal so its executable path is available, and check that
nodeandnpmrun there. Verify the installed Node version against Nightwatch’s current requirements. - No tests run: Confirm you are in the project root and that the path you supplied exists. The documented example path is
./nightwatch/examples; a customized wizard setup may put tests in another folder. - The browser does not launch or the driver exits: Confirm the browser is installed, the selected environment uses the intended
browserName, and the browser and driver versions are compatible. Review Nightwatch’s ChromeDriver instructions and WebDriver settings for paths and process settings. - The test opens the wrong page: Check the configured base URL and the route used by the test. Use a reachable local development server or the correct development URL.
- A check fails even though the page appears: Inspect the actual title, URL, text, or element value in the browser and compare it with the assertion’s expected value. If a page element appears asynchronously, use Nightwatch’s documented waiting or element APIs rather than relying on a timing guess; consult the test-writing guide.
- The HTML report is not where expected: Read the output from the run for its report path. Report location and configuration can depend on the project settings; see Nightwatch Settings.
Or skip the browser setup
If your immediate goal is to capture a webpage rather than test interactive behavior, ScreenshotNeo can return a screenshot or PDF with one GET request. It is not a replacement for Nightwatch assertions or browser automation.
Install the Python dependency with python -m pip install requests, then save this as capture.py and run it with python capture.py:
import requests
r = requests.get(
"https://api.screenshotneo.com/v1/shot",
params={"access_key": "YOUR_API_KEY", "url": "https://stripe.com"},
timeout=90,
)
open("shot.webp", "wb").write(r.content)See the ScreenshotNeo API documentation for the request and response details. Cookie/consent banners are accepted and removed before capture, along with 60+ known consent platforms, newsletter popups, and chat widgets; each of these steps can be turned off. Bot checks/CAPTCHAs, blank pages, timeouts, failed loads, and cache hits are not billed, and responses identify the page verdict and billing status in headers. ScreenshotNeo also provides an MCP server with take_screenshot, get_page_info, and capture_pdf tools for AI agents. The free plan includes 1,000 screenshots a month with no card; paid plans start at $5 for 3,000 screenshots.
Sign up for ScreenshotNeo and get 1,000 free screenshots a month with no card.
Quick wins for a faster PC:
Clear out junk files and repair common Windows errorsFree Scan →Fix the driver behind crashes, sound loss and screen glitchesFind Drivers →Repair Windows errors before they cause bigger problemsFix Now →Frequently Asked Questions
Can Nightwatch run tests without a cloud provider?
Yes. Nightwatch supports local browser execution; a remote grid or cloud service is an optional path for remote runs or broader browser and operating-system coverage.
Does Nightwatch test only Chrome?
No. Nightwatch documents support for Chrome, Firefox, Safari, and Edge. The available setup and driver requirements depend on the browser and environment.
Quick Recap
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.
