Skip to content
AppraiseJS AppraiseJS

Quick Start

First run

Go from a fresh local setup to a fully executed test flow with a report you can inspect — without writing test code.

Role: first-time QA authorsTime: 15 minutesOutcome: one runnable login validation flow
Install first Open Creating Tests

Before you begin

Section titled “Before you begin”
  • AppraiseJS is installed and `npm run start` opens the local app.
  • You have a reachable application URL for a login flow.
  • You can use non-sensitive credentials for testing.

What you’ll finish with

Section titled “What you’ll finish with”

First successful run

A complete login validation flow that: - Navigates to your app - Logs in using credentials - Verifies the user reached the home page via a welcome message - Generates a report you can inspect

New scaffolds start clean. That means everything you create here — environments, locators, test cases — reflects how real projects are structured in AppraiseJS.

Step-by-step procedure

Section titled “Step-by-step procedure”

UI path

Environments → Modules → Locators → Test Suites → Test Cases → Test Runs → Reports

This quick start builds a login validation flow that confirms a successful login by asserting a welcome message on the home page.

Each step below builds a part of a complete, executable test system.

1. Start the application

Section titled “1. Start the application”

Start AppraiseJS with npm run start and confirm the app opens in your browser.

This is your control layer — everything from test design to execution happens here.


2. Create an environment

Section titled “2. Create an environment”

Create environment Local with your application’s base URL.

Environments define where your tests run.
Appraise ties execution context directly to test intent — no external config files needed.


3. Create a module

Section titled “3. Create a module”

Create module Authentication.

Modules are not just folders — they represent functional domains.
This structure makes large test systems maintainable from day one.


4. Capture locators

Section titled “4. Capture locators”

Open Locators -> Create and use the Chromium Locator Picker to capture:

  • Email input
  • Password input
  • Submit button
  • Welcome message element

Instead of manually crafting selectors, Appraise helps you capture stable locators tied to real UI state.


5. Create a test suite

Section titled “5. Create a test suite”

Create a test suite named Login under the Authentication module.

Test suites group related flows — keeping execution and reporting organized.


6. Create the test case

Section titled “6. Create the test case”

Create a test case:

  • Title: Login
  • Description: Login with valid credentials and verify home page

Build a flow that:

  1. Navigates to the environment URL
  2. Enters email and password
  3. Clicks submit
  4. Asserts that a welcome message is visible on the home page

You are defining behavior visually — Appraise translates this into executable logic behind the scenes.


7. Run the test

Section titled “7. Run the test”

Open Test Runs -> Create and configure:

  • Test case: Login
  • Environment: Local
  • Browser: CHROMIUM
  • Workers: 1

Start the run.

No CLI commands. No runner setup. Execution is fully managed from the UI.

8. Observe execution

Section titled “8. Observe execution”

Watch the run status update in real time.

You’re seeing the exact flow executed in a real browser.

9. Inspect the report

Section titled “9. Inspect the report”

Open the generated report and confirm:

  • Steps executed correctly
  • Login succeeded
  • Welcome message is present

Here is a demo of the run execution and the report inspection in action.


💡 What just happened

Section titled “💡 What just happened”

You just:

  • Defined a test flow visually
  • Generated executable automation logic
  • Ran it using a real browser engine
  • Validated application state
  • Produced a structured report

All without writing test framework code or wiring tools together.

⏱️ What this replaces

Section titled “⏱️ What this replaces”

Traditionally, this flow requires:

  • Setting up a test framework (Playwright/Cypress)
  • Writing selectors manually
  • Writing test scripts
  • Configuring execution and reporting

With AppraiseJS:

Design → Execute → Validate → Report — all in one system

Checkpoint

Section titled “Checkpoint”
  • You can create environments, modules, locators, suites, and test cases
  • You executed a real test flow
  • You validated application state using assertions
  • You generated and inspected a report

Common mistakes

Section titled “Common mistakes”
  • Expecting starter test data in a fresh scaffold
  • Capturing locators from the wrong page
  • Running tests before all steps are configured
  • Forgetting environment selection affects execution
  • Skipping Settings -> Sync after manual file edits

Next step

Section titled “Next step”

You’ve created a complete test flow.

Now learn how to scale this into real workflows:

→ Creating Tests