RewardMan Server

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

Note

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

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

Содержание

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

---

Введение

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

Принцип работы проекта заключается преимущественно в том, что WEB приложение постоянно обменивается какой-либо информацией с сервером. Собственно, в большинстве случает в жизни так и происходит. Для обеспечения наиболее оптимального подхода к решению задачи обмена данными между WEB приложением и сервером, в проекте используется преимущественно REST API.

Сервер реализован с использованием python библиотеки (он же framework) Flask. Он готовит json ответы, сразу после того, как на определенный адрес был сделан GET или POST запрос.

Работа с базой данных пользователей так же происходит на сервере с использованием запросов на сервер и с использованием СУБД SQLAlchemic от библиотеки flask.

---

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

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

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

---

Полезные ссылки

1. Официальный сайт Python - python.org
2. Официальная документация по python Flask - flask.palletsprojects.com
3. Официальный сайт React Native reactnative.dev
4. официальный сайт PyPI - pypi.org
5. "Flask (веб-фреймворк)" - wikipedia.org
6. "HTTP-запросы: параметры, методы и коды состояния" - habr.com
7. "REST, что же ты такое? Понятное введение в технологию для ИТ-аналитиков" - habr.com
8. "Пишем API на Python (с Flask и RapidAPI)" - habr.com
9. "Создание простейшего API" - metani.com
10. "Python | Build a REST API using Flask" - geeksforgeeks.org
11. "Flask для начинающих" - habr.com
12. "Пишем веб-приложение с НУЛЯ на Python|Flask (API)" - rutube.cu

---

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

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

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

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

   • Frontend разработка WEB приложения RewardMan;
   • Схема обмена данных между клиентским и серверным приложением;
   • Консультации по backend части;
   • Поднятие и настройка сервера.

---

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

Основной код приложения разбит на две составляющие: клиентскую часть (WEB-приложение) и серверную часть (API). Конкретно в этом репозитории представлена серверная часть приложения (backend).

С исходным кодом frontend часть. проекта можно ознакомиться в репозитории RewardMan

06.12.2024