style: with info in README

This commit is contained in:
Stepan Vladovskiy 2024-06-19 01:02:05 +00:00
parent 86c091f366
commit 250947a8d1

View File

@ -1,11 +1,12 @@
## How to start
## How to start
```
npm install
npm start
```
## Useful commands
run checks
## Useful commands
run checks
```
npm run check
```
@ -18,3 +19,31 @@ fix styles, imports, formatting and autofixable linting errors:
npm run fix
npm run format
```
## Config of variables
- All vars are already in place and wroted in
```
/src/utils/config.ts
```
# End-to-End (E2E) Tests
This directory contains end-to-end tests. These tests are written using [Playwright](https://playwright.dev/)
## Structure
- `/tests/*`: This directory contains the test files.
- `/playwright.config.ts`: This is the configuration file for Playwright.
## Getting Started
Follow these steps:
1. **Install dependencies**: Run `pnpm e2e:install` to install the necessary dependencies for running the tests.
2. **Run the tests**: After using `pnpm e2e:tests`.
## Additional Information
For more information on how to write tests using Playwright - [Playwright documentation](https://playwright.dev/docs/intro).