Home Features Pricing Blog Docs


Welcome to LaunchReady! If this is your first time through, this section will help you go from the beginning to your first, integrated test run.

Table of Contents

Defining Your Application

An Application is the set of Pages and expected User Scenarios that are delivered when you deploy changes. An Application has a Default Base URL and Configurations.

Creating an Application

From the left menu, select "Applications" to view the list of your Applications:

Application List

Click "+ add Application" to define your new application:

Create Application Dialog

The DefaultBaseURL is used for trial runs when creating and modifying User Scenarios. Like all Application URLs, it must be accessible from the internet.

Enter a Name and the Default Base URL and press Save. You will be taken to the Application screen for your new Application:

Application Screen

Defining a User Scenario

A User Scenario is the set of steps a user takes in order to complete a job in your application. The best ones to start with are the ones every user will interact with frequently. The second best are the ones your developers have learned to test as the "canaries", the sneaky ones that seem to break when no one is looking.

From the left menu, select "User Scenarios" to view the list of User Scenarios (change the list at the top if it is viewing a different Application):

User Scenario Listing

Click the "+ add User Scenario" button, at the top, to start defining a new User Scenario:

Create User Scenario

A User Scenario represents a job the user is intending to perform. Provide a name and description that outline this intent. This will make it easier to identify for edits in the future.

Next, define the first Step of the User Scenario by clicking the "select action" link on Step 1:

Create User Scenario - First Step

This will open a limited list of options for the first step. Typically opening a login page is a good first step for your first User Scenario:

Create User Scenario - Valid Steps See Defining Steps for more detail on settings actions and creating pages

Adding a valid first step unlocks the buttons at the top:

Add some more steps to finish the login process and verify you end up where the user expects, then press the "Trial Run" button to test it:

Create User Scenario - Valid Steps

The "Latest Trial Run" summary will show the status as it runs, while the "Trial Run Results" section will show the details for each step.

Press "Publish" once you've validated the User Scenario is defined correctly.

Using Application Configs

Application Configs allow you to define configuration tokens that can be used in place of hard-coded values in User Scenario steps. These Configs can be overridden by your build process to provide environment or run-specific configurations.

Application Configs

Like the Default Base URL, these default values are used for manual Trial Runs, but they are also used if you do not provide override values when you start the Test Run.

Using them in a User Scenario is simple. Enter the Config name in curly braces, like so:

User Scenario - Application Config

An icon appears next to the input, indicating that it recognized the presence of a Config and what it would look like with the default Config value:

User Scenario - Application Config Sample

Updating Page Definitions

Typically there are numerous user workflows (Scenarios) in the application, often interacting with the same set of pages and controls in different ways. LaunchReady seperates the definition of Pages from the User Scenarios that reference thos epages so that a single CSS change can be reflected in one Pagfe update instead of 30 individual User Scenario updates.

Pages can be created from the Pages menu or individual User Scenarios, but can only be edited from the Pages menu:

Pages Listing

See (Adding Partial Pages)[/docs/using-the-site-adding-partial-pages] to define reusable partial pages

A Page has a Name, relative URL, list of Partial Pages, and list of Elements:

Page Editing

To edit an Element, click the corresponding "Edit" link on it's row, modify the details, and press "Save":

Page - Element Editing

Edits to Elements are applied immediately and any User Scenarios referencing the Element will use the new values immediately.

Integrating a Build Server

LaunchReady's API includes endpoints to start new Test Runs, check the status of Test Runs, and download the results of a completed Test Run. These can be integrated with deployment scripts or build services to integrated Test Runs into a deployment process.

Create an API Key

Open the Organization screen from the left menu to access API Keys:

Organization Screen

Press the "+ Add API Key" button to create a new "Application Id" and "API Key" pair:

Organization Screen - New API Key

Make sure you copy the API Key, it won't be visible again after you Save.


There are sample scripts and instructions to integrate with a variety of systems, available in the Integration section

Since all of the integrations utilize the API to interact with Test Runs, we can use a simple curl command to start a new Test Run:

curl -X POST \
  'https://app.launchready.co/api/public/v1/runs/start?applicationId=<YOUR_APPLICATION_ID>&testRunName=welcome%20docs' \
  -H 'authorization: APIAuth <API APP ID>:<API KEY>' \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/json' \
  -d '{
    "baseURL": "<YOUR SITE URL>",
    "configs": {
        "key1": "value1"

Which returns a Test Run status response like this one:

    "runId": 48,
    "isComplete": false,
    "testCaseStatsQueued": 5,
    "testCaseStatsRunning": 0,
    "testCaseStatsPassed": 0,
    "testCaseStatsFailed": 0,
    "testCaseStatsErrored": 0,
    "testCaseStatsCancelled": 0,
    "testCaseStatsTotal": 5

Reviewing Test Run Results

Once a Test Run has been started, you can see the status in the Test Runs screen:

Test Runs Listing

As tests execute in the Test Run, the icons will update to reflect their individual statuses.

Clicking a test Run will show more detail about the contents of that run:

Test Runs Screen

And you can click the User Scenario to look at the details and any associated screenshots:

Test Runs - User Scenario