Develop

.env

@@ -1 +1,2 @@
 VITE_SOME_KEY = "some value"
+API_ENDPOINT = "em-dev.usolcev.com"

README.md

@@ -1,2 +1,40 @@
 # employee_mood_frontend
-The frontend part of the "Employee mood" project curated by Yandex Accelerator
+
+## Фронтенд для приложения **Employee_mood_frontend** - профилактика и борьба с выгоранием сотрудников.
+
+## Описание проекта
+
+- Создан проект на базе библиотеки React и языком программирования TypeScript, сборщиком Vite и Redux Toolkit в качестве стейт-менеджера;
+- Реализована cемантическая, адаптивная верстка и стилизация с использовнием CSS-модулей и препроцессора SCSS;
+- Настроен роутинг с защитой роутов доступных только при авторизации;
+- Регистрация и вход пользователей по токену с его по проверкой на бекенд части приложения.
+
+## Приложение
+
+- презентационный лендинг согласно макету с возможностью авторизиции и перехода непосредственно в приложение;
+- страница авторизации с валидацией полей ввода и использованием LocalStorage;
+- главная страница с основным функционалом пользователя и визуальной частью (графики, слайдеры, кнопка получения обратной связи и визуализации его текущего психологического состояния);
+- страница с набором тестов для контроля психологического состояния работника, с возможностью их сортировки по названию, дате и результату;
+- страница с полезными статьями и видео для улучшения состояния работника, с возможностью выделения понравившихся материалов и добавления их в сохраненные, а также их сортировки по тегам и поиску по названию;
+- страница с мероприятиями, запланироваными в организации, и выделением понравившихся, а также возможностью создавать мероприятия для топ-менеджеров в специальной форме с валидацией вводимых значений;
+- страница с сохраненными статьями, видео и поисковой строкой;
+- страница "Моя команда", доступная только для топ-менеджеров, с возможностью добавления новых сотрудников, поиска сотрудника через поисковую строку и сортировка работников по имени, должности или психологическому состоянию сотрудника;
+
+## Стек:
+
+- React, TypeScript, Vite, Redux Toolkit, CSS-module, SCSS, axios;
+- Пользовательские хуки;
+- Взаимодействие с бекенд-частью приложения с применением библитеки axios.
+
+## TODO
+
+Проект дорабатывается с учетом индивидуальных потребностей заказчика.
+
+- [Ссылка на frontend часть проекта в gitHub](https://github.com/moodbeat/Frontend)
+
+## Запуск фронтенд части приложения
+
+- клонировать проект c gitHub,
+- установить зависимости (npm i),
+- в файле apiConfig.ts указать API_ENDPOINT,
+- запустить приложение: `npm run dev`.