Changed readme and added ukrainian variant

README.UKR.md

@@ -0,0 +1,191 @@
+# Healthy Hub
+
+**Опис компанії:** Healthy Hub - це компанія, що спеціалізується на розробці та
+наданні послуг у сфері здорового способу життя та фітнесу. Їхні продукти та
+сервіси орієнтовані на покращення фізичного здоров'я, діети та загального
+благополуччя користувачів.
+
+**Ймовірні клієнти:**
+
+1. **Особи, що прагнуть здорового способу життя:** Healthy Hub привертає осіб,
+   які цінують своє здоров'я та прагнуть до активного та збалансованого способу
+   життя.
+
+2. **Фітнес-ентузіасти:** Спортивні люди та ті, хто займається фітнесом,
+   знаходять цінні інструменти для відстеження та поліпшення своїх результатів.
+
+3. **Ті, хто прагне досягти конкретних цілей:** Особи, які прагнуть досягти
+   конкретних цілей, таких як збільшення чи зменшення ваги, поліпшення фізичної
+   форми тощо, знаходять в платформі підтримку та інструменти для досягнення
+   своїх мет.
+
+## Складові проекту:
+
+## Backend частина:
+
+1. Реалізовано системи авторизації для користувачів, що дозволяє їм увійти до
+   системи за допомогою унікальних облікових записів або зареєструватися у
+   системі, та вийти з облікового запису стерши токен користувача.
+
+2. Створено функціонал для відновлення паролю користувача у випадку, якщо він
+   забув свій пароль. Відправлення листа на вказану електронну пошту з новим
+   паролем.
+
+3. Підготовано даних для відображення статистичної інформації, пов'язаної з
+   використанням сервісу.
+
+4. Відображення інформації усієї інформації про користувача та відображення
+   статистики по споживанню калорій, води та ваги.
+
+5. Додано можливість змінювати дані користувача загалом та оновлювати його
+   зображення, зберігаючи його на сервісі cloudinary.
+
+6. Надано можлиість змінювати окремо дані цілі користувача та його вагу.
+
+7. Є можливість добавляти, видаляти прийоми їжі та води.
+
+8. Реалізовано системи рекомендацій, яка аналізує інформацію про користувача
+   (денні цілі) та надає персоналізовані рекомендації щодо харчування.
+
+9. Запущено проект на Swagger для полегшення співпраці та взаємодії між
+   розробниками, які працюють з різними частинами системи.
+
+## Frontend частина:
+
+### Header:
+
+![HeaderNonAuth](./assets/headerNonAuth.png)
+
+![HeaderOnSignIn](./assets/headerOnSignIn.png)
+
+![HeaderAuth](./assets/authHeader.png)
+
+В залежності авторизований користувач чи ні може відображати різну інформацію,
+якщо користувач не авторизований тоді відображає логотип компанії та навігацію
+Sign in / Sign up які підсвічуються у випадку якщо ці сторінки активні. Якщо
+авторизований тоді будуть відображатися логотип та дані про вагу, ціль, ім’я та
+аватар користувача, усі ці дані мають функції при натисканні на логотип
+пересилає на головну сторінку, при натисканні на ціль відкривається модальне
+вікно для зміни цілі користувача, при натисканні на вагу відкривається модальне
+вікно для зміни ваги та при натисканні на ім’я можна побачити посилання на
+сторінку settings та кнопку Log out.
+
+### Welcome page:
+
+![Welcome page](./assets/welcomePage.png)
+
+Сторінка яка зустрічає кожного неавторизованого користувача, містить в собі
+посилання на сторінки sign In та sign up.
+
+Sign in page:
+
+![Sign in page](./assets/signIn.png)
+
+Sign in містить в собі форму з поштою та паролем для авторизації зареєстрованого
+користувача.
+
+![Forgot password page](./assets/forgot.png)
+
+Сторінка яка дає змогу користувачеві якій забув свій пароль відновити його
+увівши пошту.
+
+Sign up page:
+
+![Sign up page](./assets/signUp.png)
+
+Сторінка реєстрації користувача яка містить в собі форму для заповнення частини
+інформації про користувача, такі як ім'я, пошта та пароль.
+
+### Your goal
+
+![Goal](./assets/goal.png)
+
+Секція реєстрації користувача яка продовжує заповнення форми про користувача з
+інформацією про його ціль.
+
+### Select gender, Age
+
+![Select gender, Age](./assets/gender.png)
+
+Ця секція також продовжує реєстрацію користувача, в якій користувач може вибрати
+стать та вік.
+
+### Body parameters
+
+![Parameters](./assets/params.png)
+
+Ця секція реєстрації, відповідає за дані про вагу та ріст користувача.
+
+### Your Activity
+
+![Activity](./assets/activity.png)
+
+Ця секція реєстрації відповідає за дані про фізичну активніст, саме тут і є
+кнопка Sing Up яка відповідає за реєстрацію користувача та внесення даних на
+backend.
+
+### Main page:
+
+![Main page](./assets/main.png)
+
+Головна сторінка авторизованого користувача, містить найважливіші дані для
+користувача, має кілька секцій.
+
+**Секція Today**
+
+Ця секція містить денну ціль по споживанню води та калорій, також тут є
+можливість вностит дані про спожиту воду та побачити скільки ще потрібно випити,
+ще є частина з калоріями та нутрієнтами де можна необхідну їх кількість та
+графік їх споживання. Також ця секція має посилання на сторінку Dashboard.
+
+**Секція Diary**
+
+За допомогою цієї секції користувачі можуть легко фіксувати свої щоденні прийоми
+їжі, реєструючи деталі щодо вживаних продуктів. Також користувач може слідкувати
+за вмістом вуглеводів, білків, жирів в введених продуктах харчування за кожним
+прийомом їжі. Ще тут є посилання на повний список на сторінці Diary.
+
+**Секція Recommended Food**
+
+В даній секції зареєстрований користувач може побачити скорочений список
+рекомендованих продуктів та yатиснуваши на кнопку “see more” користувач
+потрапляє на сторінку recommended food бачить весь список рекомендованих йому
+продуктів.
+
+### Dashboard:
+
+![Dashboard](./assets/dashboard.png)
+
+На сторінці можна проглядати свою статистику за цей або минулий місяць яка
+влючає у себе графік вживаних калорій та випитої води а також числовий графік
+вашої ваги. На цій сторінці зручно відслідковувати свій прогресс по набору або
+скиданню ваги та слідкувати за кількістю вживання води та калорій на протязі
+поточного або минулого місяця.
+
+### Diary page:
+
+![Diary](./assets/diary.png)
+
+Надає інформацію про прийоми їжі, які страви були спожиті на сніданок, обід,
+вечерю та перекус, надає можливість додавати та змінювати страву, його калорії
+та нутрієнти та розраховує загальну суму за прийом їжі.
+
+### Recommended food:
+
+![Recommended food](./assets/recommendedFood.png)
+
+В даному розділі зареєстрований користувач може побачити продукти які йому краще
+споживати для досягнення своіх персональних потреб, вирахуваних на основі мети
+(наприклад схуднення або набір м’язів) а також ваги та раціону. До того ж в
+картках вказана кількість калорій на 100 грам продукту.
+
+### Settings page:
+
+![Settings page](./assets/settings.png)
+
+На сторінці Settings можна знайти повну інформацію по користувач, таку як: ім’я,
+вік, стать, ріст, вага, фізична активність та аватар користувача. Ці дані можна
+легко змінити, на числових даних проставлено валідацію щоб користувач міг
+уникнути помилки та на місті фото користувача можна одразу побачити обраний
+автар, зміни зберігаються після натискання кнопки save, також можна відмінити
+зміни натиснувши кнопку cancel.