Change The Scripts Of Tests & Update Docs (#97)

Co-authored-by: NoamGaash <[email protected]>

.prettierignore

@@ -1 +1,2 @@
-**/generated/*
+**/generated/*
+README.md

README.md

@@ -24,8 +24,8 @@ This app is created by the volunteers of [Public Knowledge Workshop](https://www
 - `yarn start`
 
 ### testing the project:
-- running the tests - `yarn playwright test`
-- running the tests with UI - `yarn playwright test --ui`
+- running the tests - `yarn test`
+- running the tests with UI - `yarn test:ui`
 - additional helpful flags - https://playwright.dev/docs/test-cli
 
 ### useful resources:

package.json

@@ -45,8 +45,8 @@
     "start": "vite",
     "build": "tsc && vite build",
     "serve": "vite preview",
-    "test": "echo \"no default test defined. to run playwright test, use `npm run test:playwright`\"",
-    "test:playwright": "playwright test",
+    "test": "playwright test",
+    "test:ui": "playwright test --ui",
     "lint": "eslint . --max-warnings 0",
     "lint:fix": "eslint . --fix",
     "format": "prettier --write './**/*.{js,jsx,ts,tsx,css,md,json}' --config ./.prettierrc"