Skip to main content
Version: 7.5.5

Quick start


The official guide assumes immediate knowledge of the target platform:

  • For web applications the user should be familiar with HTML, CSS, JavaScript and BDD.
  • For mobile applications the user should be familiar with Appium, Android & IOS.
  • Test Maker developers need also to be familiar with nodejs , typescript and npm. If you are totally new to any of those concepts, it might not be the best idea to jump right into a framework as your first step - grasp the basics then come back! Prior experience with other frameworks helps, but is not required.

    Also check the Learning Resources section.


    After making sure the requirements are met:

  • Create a project folder e.g. my-test-project (avoid the path that includes spaces)
  • Open a Command-Line prompt (CMD) and make sure you are working in the context of that project folder
  • Initialise the project

    Initialize the project by typing:

    npm init
  • Fill the required questions and continue ( 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": ""

    Test Maker

    Once you have access to the Test Maker GitHub repository, follow the instructions to create your ssh key and add it to your GitHub account (you might need Git bash for the very first usage of that key to activate it). Then in the project folder, from the command line run:

    npm install git+ssh://

    If the command does not resolve, download Test Maker as zip file under the project folder. img.png