RewardMan

Frontend часть проекта

Note

Веб-приложение для специализированного продвижения достижений пользователей, а также удобного ранжирования их навыков и компетенций.

Система оценивания и социального рейтинга за достижения и личного мнения.

Содержание

1. Введение
2. Структура репозитория
3. Полезные материалы и источники
4. Запуск проекта
5. Лицензии и авторства
6. Дополнительно

---

Введение

RewardMan - WEB приложение, нацеленное на улучшение рабочего процесса путем конкуренции и анонимного социального рейтинга.

Дело в том, что какая бы интересная задача не была с первого взгляда, интерес к ней субъективен. Люди редко делают то, что им не нужно или не интересно, особенно если им за это ничего не будет. И "прокачка soft скилов" не сильно то и мотивирует, особенно если учесть, что некоторые задачи требуют куда больше усилий при реализации, чем что-то приятное или полезное. В то же время, если суметь заинтересовать человека какой-то идей или поощрением (в виде подарка или различного рода смягчениями), то рабочий процесс может пойти куда лучше. 📈

Как раз на такие случаи и рассчитан RewardMan, где слово reward (с англ.) означает "награда" или "вознаграждение". Суть в том, что лучший (или группа лучших) в списке рейтинга будет получать от администратора группы какие-то вознаграждения (на усмотрение администратора). В то же время у каждого участника группы есть набор задач и соответственно реализуемые баллы за выполнение этих задач. Набирая баллы человек поднимается все выше в рейтинге участников. В случае если человек не хочет или не может выполнить задачу, то он может досрочно закрыть ее. В таком случае администратор устанавливает баллы на свое усмотрение .

Проект может быть полезен для различных групп людей, например, для студентов и преподавателя, для сотрудников компании и их начальником, для членов клубов и организаций и судей турниров этого клуба. Способов применить данный проект множетсво, главное суметь правильно понять суть и не забывать проставлять баллы 😊.

---

Структура репозитория

Данный репозиторий разбит на несколько составляющих частей:

1. Файл запуска - App.js: файл необходим для запуска проекта с использованием Node.js.
2. Директория скриптов - src: здесь храниться исходный код компонентов и отдельных страниц приложения.
3. Директория материалов - assets: здесь хранятся все изображения, иконки, шрифты и прочие материалы, которые используются в приложении.
4. Директория документации - doc: здесь находятся файлы с техническим заданием проекта, инструкции по развертыванию приложения и инструкции по пользованию приложением
5. Файл лицензий - LICENSE: файл с лицензией распространения открытого исходного кода RewardMan.
6. Файл фильтрации данных в репозитории - .gitignore: файл необходим для фильтрации мусора разных надстроек.
7. Директория настроек vscode - .vscode: личные настройки проекта в программе Visual Studio Code.
8. Файл настройки стилей - .prettierrc: файл необходим для реализации единой стилистики написания кода через форматеры.
9. Файл конфигурации приложения - app.json: файл необходим для запуска приложения с использованием Node.js.

---

Полезные материалы и источники

1. Официальный сайт Python - python.org
2. Официальный сайт React Native reactnative.dev
3. Официальная документация по GitHub Pages - docs.github.com
4. Официальный сайт expo - expo.dev
5. "Состоялся релиз Expo SDK 50" - habr.com
6. "HTTP-запросы: параметры, методы и коды состояния" - habr.com
7. "REST, что же ты такое? Понятное введение в технологию для ИТ-аналитиков" - habr.com
8. "React Native для самых маленьких. Опыт мобильной разработки" - habr.com
9. "Изучение React Native" - YouTube.com

---

Запуск проекта

Проект выполнен с использованием framework'а React Native, который, в свою очередь, выполняется с использованием пакетного менеджера npm или, как его еще можно назвать, Node.js.

Следовательно чтобы запустить проект необходимо выполнить ряд команд:

1. Для начала скопируем репозиторий на локальную машину:

   git clone https://github.com/Livegress/RewardMan.git

2. Перейти в рабочий каталог:

   cd RewardMan

3. Установить все зависимости и библиотеки (пакеты):

   npm install

4. Запустить проект:

   npm start

   или же

   npx expo start --web

   Во-втором случае проект запускается сразу в WEB браузере.

Полные список команд:

git clone https://github.com/Livegress/RewardMan.git
cd RewardMan
npm install
npm start

---

Лицензии и авторства

Проект выполнены командой Livegress.

Открытый исходный код распространится под лицензией GNU GENERAL PUBLIC LICENSE в 2024 году. С файлом лицензии можно ознакомиться по ссылке.

Над проектом работали:

1. Воронов Никита:

   • Frontend разработка WEB приложения RewardMan;

   • Схема обмена данных между клиентским и серверным приложением;

   • Консультации по backend части;

   • Поднятие и настройка сервера.

   • Backend разработка WEB приложения RewardMan

   • Развертывание базы данных на сервере

   • Построения JSON дерева;

   • Логика Flask ответов на запросы от приложения.

2. Огур Александр:

   • Backend разработка WEB приложения RewardMan;
   • Развертывание базы данных на сервере;
   • Построения JSON дерева;
   • Логика Flask ответов на запросы от приложения.

---

Дополнительно

В данном репозитории представлена исключительно пользовательская модель приложения. Логика распространения, логика POST и REST запросов, обработка ошибок и т.п. представлены в репозитории RewardMan-server.

20.01.2024