Skip to content

Commit 4f46c15

Browse files
committed
updated docs
1 parent 1a16162 commit 4f46c15

File tree

4 files changed

+173
-126
lines changed

4 files changed

+173
-126
lines changed

README.md

+49-4
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,70 @@
11
# CodeceptUI
22

3-
An interactive, graphical test runner for CodeceptJS.
3+
An interactive, graphical test runner for [CodeceptJS](https://codecept.io).
44

55

6-
![codepress video](./codeceptui.gif)
6+
![codeceptui](./codecept-ui2.gif)
7+
8+
* Runs as Electron app or as a web server
9+
* Headless & window mode supported
10+
* Test write mode
11+
* Interactive pause built-in
12+
* Snapshots & Time travel
13+
* Runs tests in CodeceptJS supported engines:
14+
* Playwright
15+
* Puppeteer
16+
* webdriverio
17+
* TestCafe
718

819
## Quickstart
920

21+
**Requires [CodeceptJS 3](https://codecept.io) to be installed**
22+
1023
Install CodeceptUI in a project where CodeceptJS is already used
1124

1225
```
1326
npm i @codeceptjs/ui --save
1427
```
1528

16-
Execute it
29+
### Application Mode
30+
31+
Run CodeceptUI in application mode (recommended for development, local debug):
32+
33+
```
34+
npx codecept-ui --app
35+
```
36+
37+
Uses `codecept.conf.js` config from the current directory.
38+
39+
If needed, provide a path to config file with `--config` option:
40+
41+
```
42+
npx codecept run --config tests/codecept.conf.js
43+
```
44+
45+
### WebServer Mode
46+
47+
![](./codeceptui.gif)
48+
49+
Run CodeceptUI as a web server (recommended for headless mode, remote debug):
1750

1851
```
1952
npx codecept-ui
2053
```
2154

22-
## Development Mode
55+
Open `http://localhost:3001` to see all tests and run them.
56+
57+
58+
Uses `codecept.conf.js` config from the current directory.
59+
60+
If needed, provide a path to config file with `--config` option:
61+
62+
```
63+
npx codecept run --config tests/codecept.conf.js
64+
```
65+
66+
67+
## Development
2368

2469
See [CONTRIBUTING.md](https://github.com/codecept-js/ui/blob/master/.github/CONTRIBUTING.md)
2570

codecept-ui2.gif

381 KB
Loading

0 commit comments

Comments
 (0)