From 250947a8d14a44e98b414f9cf27cb3e62353de4e Mon Sep 17 00:00:00 2001 From: Stepan Vladovskiy Date: Wed, 19 Jun 2024 01:02:05 +0000 Subject: [PATCH] style: with info in README --- README.md | 35 ++++++++++++++++++++++++++++++++--- 1 file changed, 32 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d11dd24b..adfadc64 100644 --- a/README.md +++ b/README.md @@ -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).