Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ianjennings authored Mar 8, 2024
1 parent 81c2891 commit 0574165
Showing 1 changed file with 21 additions and 8 deletions.
29 changes: 21 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# TestDriver [Web]
# TestDriver - Web Quickstart

TestDriver is an AI QA Agent for GitHub. TestDriver allows you to run UI tests on your software using plaintext prompts. Every TestDriver test spawns an ephemeral VM and uploads the results to [Dashcam](https://dashcam.io) for easy debugging.

Expand Down Expand Up @@ -47,31 +47,44 @@ The best way to write your prompt is to open an incognito window and perform the
TestDriver reports it's results within the GitHub actions interface.
![CleanShot 2024-03-08 at 17 20 42@2x](https://github.com/dashcamio/testdriver-web/assets/318295/83185198-0550-42c5-ae3e-3734e5e1ddee)
<img src="https://github.com/dashcamio/testdriver-web/assets/318295/83185198-0550-42c5-ae3e-3734e5e1ddee" width="500">
Once you click `Details` you can view the AI-generated test summary and Dashcam results under `Summary`. Click "View Recording" or click on the thumbnail to launch the Dashcam interface.

<img width="1459" alt="CleanShot 2024-03-08 at 17 21 45@2x" src="https://github.com/dashcamio/testdriver-web/assets/318295/b90d6e20-9ff3-476f-8d78-223fa2f76385">
<img src="https://github.com/dashcamio/testdriver-web/assets/318295/b90d6e20-9ff3-476f-8d78-223fa2f76385" width="500">

## Dashcam Replay
## Test Replay

### AI Logs

You may need to select `CLI` under `APP` to view the TestDriver AI logs (marked in yellow). You'll see your prompt is fed to the AI one step at a time. Whenever the `>` appears, that is input to the AI.

You'll see the AI execute code (marked in green) that it has generated to accomplish your task.

As you play the video, the logs will playback in real time. Past logs are 100% opacity and future logs are reduced opacity. You can click on any timestamp to navigate to the point in the video where those logs were produced.

<img src="https://github.com/dashcamio/testdriver-web/assets/318295/bc9f339e-949c-4a39-9314-14ddbbd356ae" width="500">

### Chrome Logs

The Chrome console logs and network requests are available under the "Chrome" tab:
The Chrome console logs and network requests recorded from the test are available under the "Chrome" tab.

<img src="https://github.com/dashcamio/testdriver-web/assets/318295/70d3e77c-342f-46cc-95c1-5765bc1fa993" width="500">

## Building your application for development

If you do not already have deploy previews from something like Vercel or Netlify, you may build your application for testing on the machine at run time. Note that TestDriver will clone the repository and branch from which it is run.

In order to build your application, modify [the `.testdriver/prerun.sh` script](https://github.com/dashcamio/testdriver-web/blob/main/.testdriver/prerun.sh) to include your build steps. Fore example, you may add `npm build` here.

![CleanShot 2024-03-08 at 17 25 18@2x](https://github.com/dashcamio/testdriver-web/assets/318295/70d3e77c-342f-46cc-95c1-5765bc1fa993)
Note that currently causing an exception within `prerun.sh` may cause the test to silently fail.

# Roadmap

- [x] Mac Support
- [ ] Windows Support (5 minutes faster and 10x scale)
- [ ] Account Linking
- [ ] Publi<img width="1495" alt="CleanShot 2024-03-08 at 17 23 49@2x" src="https://github.com/dashcamio/testdriver-web/assets/318295/c2c6bfe6-0482-4f95-bf48-4d3ffe361487">
sh to your own Dashcam.io Account
- [ ] Publish to your own Dashcam.io Account
- [ ] Choose Dashcam Project to upload to
- [ ] Publish GitHub action into the store
- [ ] Streaming results
Expand Down

0 comments on commit 0574165

Please sign in to comment.