Skip to content

Commit f2f0bb4

Browse files
authored
Merge pull request LambdaTest#1504 from GarvitLT/stage
Added Sample Project
2 parents ac09b8d + e451257 commit f2f0bb4

File tree

1 file changed

+22
-11
lines changed

1 file changed

+22
-11
lines changed

docs/hyperexecute-cli-gui.md

Lines changed: 22 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -59,15 +59,11 @@ HyperExecute GUI is currently in **BETA** and supports the **Java TestNG Framewo
5959

6060
<img src={require('../assets/images/hyperexecute/gui/gui_template.webp').default} />
6161

62-
## Getting Started in 5 Simple Steps
62+
## Pre-Requisites
6363
---
6464

65-
<video class="right-side" width="100%" controls id="vid">
66-
<source src= {require('../assets/videos/hyperexecute/cli-gui/GUI_Demo.mp4').default} type="video/mp4" />
67-
</video>
68-
69-
### Step 1: Download and Install
70-
Download the HyperExecute GUI installer from your LambdaTest dashboard and install it on your system. Run the installer by following the on-screen instructions and launch HyperExecute GUI from your applications menu.
65+
Before getting started, download the HyperExecute GUI installer from your LambdaTest dashboard and install it on your system. Run the installer by following the on-screen instructions and launch HyperExecute GUI from your applications menu.
66+
Currently HyperExecute GUI is a part of the **LambdaTest Underpass Application**. If you already have Underpass app on your system, please update it to latest version.
7167

7268
:::tip Download the GUI 🔗
7369
You can download the app directly from your **HyperExecute Dashboard** or simply click the links below based on your operating system:
@@ -76,13 +72,28 @@ You can download the app directly from your **HyperExecute Dashboard** or simply
7672
- **[Download for Linux](https://downloads.lambdatest.com/underpass/master/UnderPass.AppImage)**
7773
:::
7874

79-
### Step 2: Select and Analyze Your Project
75+
## Getting Started in 4 Simple Steps
76+
---
77+
78+
### Demo Walkthrough
79+
80+
Please checkout this video demo which walks you through the step by step process of using the GUI App using a demo project. All the steps taken in this video are explained in detail in the following step by step guide too.
81+
82+
<video class="right-side" width="100%" controls id="vid">
83+
<source src= {require('../assets/videos/hyperexecute/cli-gui/GUI_Demo.mp4').default} type="video/mp4" />
84+
</video>
85+
86+
### Step 1: Select and Analyze Your Project
8087
Launch the application, log in with your LambdaTest credentials, and select your test project folder. The GUI will automatically analyze your project i.e.:
8188

8289
- Detect your testing framework and language
8390
- Verify and manages network connectivity
8491
- Set up a secure connection to your account
8592

93+
:::tip Sample Project 🔗
94+
If you do not have a project handy, please feel free to use this **[Sample Project](https://github.com/LambdaTest/testng-selenium-hyperexecute-sample)** for trying out the GUI.
95+
:::
96+
8697
<video class="right-side" width="100%" controls id="vid">
8798
<source src= {require('../assets/videos/hyperexecute/cli-gui/projectselect_analyze.mp4').default} type="video/mp4" />
8899
</video>
@@ -93,7 +104,7 @@ The GUI will check the system and your project to ensure everything is ready. If
93104
- **Network connectivity issues**: If the GUI can't connect to LambdaTest servers, it will ask you to set up the necessary network settings through proxy.
94105
:::
95106

96-
### Step 3: Discover and Select Tests
107+
### Step 2: Discover and Select Tests
97108
Once you land on the Project Screen, the app will automatically initiate Test Discovery. **Test Discovery is an automated process** that scans your project to identify and group all test cases by **Suites, Files, Classes or Methods**.
98109

99110
This feature eliminates the need for manual test configuration and makes it easy to select which tests to run. Once you have selected the tests from "Test List" tab according to your preferences, either you can **directly run the job** or move to the next step for **additional configuration**.
@@ -106,13 +117,13 @@ This feature eliminates the need for manual test configuration and makes it easy
106117
Search within tests is not yet available on the GUI. We are working to make it available soon.
107118
:::
108119

109-
### Step 4: Specify Run Config _[Optional]_
120+
### Step 3: Specify Run Config _[Optional]_
110121
The **Run Config tab** in HyperExecute GUI offers an intuitive visual interface to configure your test environment and execution settings.
111122
You’ll find the basic preset configurations displayed just below your project name. If you need to modify or customize these settings, simply navigate to the Run Config tab and adjust your execution environment effortlessly — _no YAML editing required_.
112123

113124
To learn about any configuration in detail, please search for the keyword in the **[HyperExecute YAML Documentation](/support/docs/deep-dive-into-hyperexecute-yaml)**.
114125

115-
### Step 5: Run Tests and View Job
126+
### Step 4: Run Tests and View Job
116127
Click on the **Run Test** button to start the test execution. A pop with job status and creation logs will appear with options to Expand and View Job. Click on the **View Job** button to get redirected to the job dashboard once the job is created. The HyperExecute-GUI displays the job logs in real-time as your tests run. Once complete, you can view the detailed test results in the HyperExecute Dashboard.
117128

118129
<video class="right-side" width="100%" controls id="vid">

0 commit comments

Comments
 (0)