README.md

Nightwatch Typescript Boilerplate

🧑‍💻 Developer ready: This project shows example of Nightwatch end-to-end tests written in typescript.

• Basic Examples using TypeScript
• Examples using Page Object Model
  • Page Object Definitions
    • Using satisfies operator
    • Without satisfies operator (for TypeScript < 4.9)
    • Using Page Object Sections
  • Page Object Examples
• Custom command example

Other features:

• TypeScript 4.9
• ESLint with some initial rules recommendation
• NPM scripts for common operations
• .editorconfig for consistent file format
• VSCode Integration
• Multiple Configurations (Chromedriver, Cucumberjs, Browserstack)
• Cross Platform Example Tests

Getting started

This project is intended to be used with the latest Active LTS release of Node.js.

Use as a repository template

To start, just click the Use template link (or the green button). Start adding your code in the src.

Clone repository

To clone the repository, use the following commands:

git clone https://github.com/nightwatchjs/nightwatch-typescript-boilerplate
cd nightwatch-typescript-boilerplate
npm install

Available Scripts

• clean - remove transpiled files, logs and test output.
• build - transpile TypeScript to ES6,
• clean:build - run both clean and build command
• test - run nightwatch test,
• test-browserstack - run nightwatch tests on browserstack. (To run test in Browserstack, create .env file with the credentials)
• lint - lint source files,
• lint-and-fix - lint source files and fix the lint issue

License

Licensed under the MIT. See the LICENSE file for details.