Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
You can copy commands.
  • Loading branch information
jalezi authored Mar 6, 2024
1 parent d7d6910 commit 72d0b3f
Showing 1 changed file with 48 additions and 15 deletions.
63 changes: 48 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,11 @@

For setting up development environment locally run:

1. `yarn install`
2. ...TODO
1. Install depenencies
```
yarn install
```
3. ...TODO

## Data source

Expand Down Expand Up @@ -37,11 +40,15 @@ All used libraries can be seen on [GitHub dependancies](https://github.com/sledi

### CLI Usage

`yarn lint`
```
yarn lint
```

If you also want to automatically fix the project errors:

`yarn lint --fix`
```
yarn lint --fix
```

### IDE Usage

Expand All @@ -57,7 +64,10 @@ Have a look at step 3 of [this article from DigitalOcean](https://www.digitaloce

### Unit Tests

#### `yarn test:unit`
Runs unit tests.
```
yarn test:unit
```

Launches the test runner in the interactive watch mode.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
Expand All @@ -67,21 +77,44 @@ See the section about [running tests](https://facebook.github.io/create-react-ap
Documentation: [Playwright](https://playwright.dev/docs/intro)
[VS Code extension](https://marketplace.visualstudio.com/items?itemName=ms-playwright.playwright)

#### `yarn playwright test` | `yarn test:e2e`
Runs the end-to-end tests.
```
yarn playwright test
```

Runs the end-to-end tests.
or

Other helpful cli commands:

- `yarn playwright test --ui`, starts the interactive UI mode.
```
yarn test:e2e
```

- `yarn playwright test --project=chromium`, runs the tests only on Desktop Chrome.

- `yarn playwright test example`, runs the tests in a specific file.

- `yarn playwright test --debug`, runs the tests in debug mode.
Other helpful cli commands:

- `yarn playwright codegen`, auto generate tests with Codegen.
Starts the interactive UI mode
```
yarn playwright test --ui
```

Runs the tests only on Desktop Chrome
```
yarn playwright test --project=chromium
```

Runs the tests in a specific file.
```
yarn playwright test example
```

Runs the tests in debug mode.
```
yarn playwright test --debug
```

Auto generate tests with Codegen.
```
yarn playwright codegen
```

## Generic React App instructions (to be removed or minimized)

Expand Down

0 comments on commit 72d0b3f

Please sign in to comment.