Nightwatch.js

Homepage • Developer Guide • API Reference • About • Blog

Nightwatch is an integrated testing framework powered by Node.js and using the W3C Webdriver API. It is a complete testing solution developed at BrowserStack and which can be used for:

☑️ end-to-end testing of web applications and websites

☑️ component testing in isolation (React / Vue / Storybook / Angular)

☑️ Node.js unit, visual regression testing, accessibility testing & API testing

☑️ Native mobile app testing on Android & iOS

---

1. Install Nightwatch from NPM

From your existing project's root dir:

npm init nightwatch@latest

or, if you want to initialize a new project:

npm init nightwatch@latest ./path/to/new/project

For testing on mobile browsers only:

npm init nightwatch@latest -- --mobile

Generate a new config file in your existing Nightwatch project:

npm init nightwatch@latest -- --generate-config

2. Answer a few questions about your preferred setup:

• What is your Language - Test Runner setup?
• Where do you want to run your e2e tests?
• Which browsers will you be testing on?
• Where do you plan to keep your end-to-end tests?
• What is the base_url of your project?
• Allow Nightwatch to anonymously collect usage metrics?
• Would you like to run your e2e tests on Mobile devices as well?

Nightwatch will do the entire setup for you based on your answers.

3. Run a Demo Test:

Nightwatch comes with a few examples, which are automatically copied to your Nightwatch project during the setup and can also be used as boilerplate to write your own tests on top of them.

You can follow the instructions given at the end of the setup to run your first test with Nightwatch.

Licence

MIT