create-nightwatch

The Nightwatch CLI tool lets you setup Nightwatch.js in your new or existing project, with all the required configs and dependencies, with just one command.

Homepage • Developer Guide • API Reference • About • Blog

Get started in 60 seconds

1. Install Nightwatch from NPM

# from your existing project's root dir
$ npm init nightwatch

# if you want to initialize a new project
$ npm init nightwatch path/to/new/project

# for testing on mobile browsers only
$ npm init nightwatch -- --mobile

# generate a new config file in your existing
# Nightwatch project (also installs webdrivers
# and other required packages).
$ npm init nightwatch -- --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