Skip to main content
Version: 9.0.0

Quick Start

Installation​

Requirements​

Before proceeding, ensure that you have met the system requirements.

Project Setup​

  1. Create a project folder for your tests, e.g., my-test-project (avoid spaces in the path).
  2. Open a Command-Line prompt (CMD) and navigate to the project folder.

Initialize the Project​

Initialize the project by running the following command:

npm init

  • Fill out the required details or press enter to accept the default values (if you don't have any specific requirements, hitting enter for all is ok, and default values will be set for you). You can also add -y after the word init in the command above.

  • Now you will see a new package.json file, created for you, that will act as the manifest for your project.

{
  "name": "my-test-project",
  "version": "1.0.0",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "",
  "license": "ISC",
  "description": ""
}

Install Test Maker​

Download Test Maker as a compressed file and add it to your project folder.

  • If a compressed Test Maker file has been shared with you, install it using npm:

As part of source control we recommend having Test Maker file inside the project folder.

npm i '/Users/your_user/project_name/test-maker-8.0.0.tgz'
  • For users with an earlier version of Test Maker, you may need to use the "--ignore-scripts" option:
npm i --ignore-scripts test-maker-7.5.5.tar.gz

Generate Test Maker project template​

From CMD, just run the following:

npx ketm init

You will get something similar to the image below:

ketm init

You have multiple options to choose from to initialize a Test Maker project: Test Maker will provide multiple options for the type of initialization you want, choose Init express and hit Enter.

You will see the list of files, and scripts Test Maker created in your project folder.

Running The Test​

From CMD, just run the following:

npm run test:local

Test Maker will start and you should see something similar to the below image:

run

Reporters​

By default, Test Maker comes with the terminal reporter auto-activated. Have a look at some of the great features of the terminal reporter :)

reporter

Test Maker provides a clear and user-friendly way to view the results of test executions, including information about which report has been generated based on the chosen configuration.

executionResult