feat: added description to readme file #4

frontend/README.md

@@ -1,27 +1,28 @@
-# React + TypeScript + Vite
+## Install dependencies
+> yarn install
 
-This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+## Start local server
+> yarn run dev
 
-Currently, two official plugins are available:
+## Build the production ready code to the /dist folder
+> yarn run build
 
-- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
-- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
+## Build Automatically
+All environment variables must be registered as a secret on GitHub ```ENV_VARIABLES``` for correct automatic building of the project.
 
-## Expanding the ESLint configuration
+## Build Locally
+1. Create file ```.env``` in the root of the project and set all environment variables in it.
+2. The ```yarn run build``` command will build the project into the ```dist``` folder.
+4. The ```yarn run dev``` command will run the project on the local server in development mode.
 
-If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:
+## ESlint check
+> yarn lint
 
-- Configure the top-level `parserOptions` property like this:
+## ESlint fix
+> yarn lint:fix
 
-```js
-   parserOptions: {
-    ecmaVersion: 'latest',
-    sourceType: 'module',
-    project: ['./tsconfig.json', './tsconfig.node.json'],
-    tsconfigRootDir: __dirname,
-   },
-```
+## Formatting check
+> yarn format
 
-- Replace `plugin:@typescript-eslint/recommended` to `plugin:@typescript-eslint/recommended-type-checked` or `plugin:@typescript-eslint/strict-type-checked`
-- Optionally add `plugin:@typescript-eslint/stylistic-type-checked`
-- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and add `plugin:react/recommended` & `plugin:react/jsx-runtime` to the `extends` list
+## Formatting fix
+> yarn format:fix