|
1 | 1 | # CodeceptUI
|
2 | 2 |
|
3 |
| -An interactive, graphical test runner for CodeceptJS. |
| 3 | +An interactive, graphical test runner for [CodeceptJS](https://codecept.io). |
4 | 4 |
|
5 | 5 |
|
6 |
| - |
| 6 | + |
| 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 |
7 | 18 |
|
8 | 19 | ## Quickstart
|
9 | 20 |
|
| 21 | +**Requires [CodeceptJS 3](https://codecept.io) to be installed** |
| 22 | + |
10 | 23 | Install CodeceptUI in a project where CodeceptJS is already used
|
11 | 24 |
|
12 | 25 | ```
|
13 | 26 | npm i @codeceptjs/ui --save
|
14 | 27 | ```
|
15 | 28 |
|
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 | + |
| 48 | + |
| 49 | +Run CodeceptUI as a web server (recommended for headless mode, remote debug): |
17 | 50 |
|
18 | 51 | ```
|
19 | 52 | npx codecept-ui
|
20 | 53 | ```
|
21 | 54 |
|
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 |
23 | 68 |
|
24 | 69 | See [CONTRIBUTING.md](https://github.com/codecept-js/ui/blob/master/.github/CONTRIBUTING.md)
|
25 | 70 |
|
|
0 commit comments