---

✨ Описание проекта ✨

---

Каждый репозиторий на GitHub — это не просто код, это отражение чьего-то видения, идеи и стремления к совершенству. Проект на GitHub — это живой организм, который эволюционирует, учится и растет.

---

Внешний вид графического интерфейса на React:

Презентация проекта находится Пока не здесь

• Структура репозитория
• Необходимые требования
• Установка и настройка
  • Установка виртуальной среды и зависимостей
    • Linux server
    • Windows server
  • Запуск тестов
    • Linux server
    • Windows server

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

    .
    ├── logs # - папка храенения логов
    |   ├── setup #
    |   |   ├── *.log #
    |   └── app.log #
    ├── setup - кастомный установщик среды
    |   ├── check_local_modules.py - проверка локальных модулей
    |   ├── debug_info.py - вывод информации
    |   ├── setup_common.py
    |   ├── setup_windows.py - установочное меню
    |   └── validate_requirements.py - валидация модулей
    ├── src
    |   ├── database - база данных
    |   |   ├── models.py - модели
    |   |   └── my_connector.py - класс для подключения к базе данных
    |   ├── images - статические файлы
    |   ├── pipeline - пайплайны
    |   |   ├── server.py - uvicorn сервер
    |   |   └── test.py - тесты CRUD операций
    |   ├── repository - репозитории
    |   |   └── ...
    |   ├── scripts - скрипты
    |   ├── service - сервисы
    |   |   └── ...
    |   ├── utils
    |   |   ├── custom_logging.py - кастомный лог
    |   |   ├── exam_services.py - проверка на дубликаты
    |   |   ├── hashing.py - хеширование паролей
    |   |   ├── return_url_object.py - скрипт для формирования ссылок на изображения
    |   |   ├── write_file_into_server.py - запись файлов на сервер
    |   |   └── ...
    ├── venv # - виртуальная среда
    ├── .env # - переменные среды
    ├── .gitignore
    ├── create_sql.py - скрипт для авто создания и заполнения базы данных
    ├── env.py - скрипт для работы с переменными средами
    ├── main.bat - запуск сервера на windows
    ├── main.sh - запуск сервера на linux
    ├── TimeCase.sql - sql скрипт для создания базы данных
    ├── requirements.txt - список зависимостей
    ├── requirements_external.txt - дополнительныйсписок зависимостей
    ├── setup.bat - установка среды на windows
    ├── setup.log # - файл лога
    └── setup.sh - установка среды на linux

Реляционная база данных:

Требования

• Python 3.9+
• pm2 (для управления процессами сервера на Linux/MacOS)

Установка и настройка

1. Установка виртуальной среды и зависимостей

Linux/MacOS

• Клонируйте репозиторий на сервер:

  git clone https://github.com/Prischli-Drink-Coffee/TimeCast.git
  cd repo

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

  bash setup.sh

• Следуйте инструкциям в консоли для установки пакетов

Windows

• Клонируйте репозиторий на сервер:

  git clone https://github.com/Prischli-Drink-Coffee/TimeCast.git
  cd repo

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

  setup.bat

• Следуйте инструкциям в консоли для установки пакетов

2. Запуск сервера

• Запустите скрипт через pm2 для Linux/MacOS

  pm2 start 'bash pm2.sh'

• Запустите через меню выбора для Linux/MacOS

  main.sh # пункт 3 в меню

• Запустите скрипт для запуска сервера на Windows

  main.bat # пункт 3 в меню

3. Запуск тестов CRUD операций базы данных

Для запуска автоматической проверки тестов с использованием pytest, выполните:

bash test_main.sh

Для запуска автоматической проверки тестов с использованием pytest, выполните:

 test_main.bat

Сервер можно запустить локально или в веб-пространстве, тогда вы получите доступ к пользовательскому интерфейсу, для настройки сервера достаточно указать переменные среды в таком формате:

UPLOAD_DIR=./public
DATA_PATH=./public/data
PLOTS_PATH=./public/plots
ZIP_PATH=./public/zip
WEIGHTS_CLASSIC_PATH=./src/weights_classic
WEIGHTS_NEIRO_PATH=./src/weights_neiro
HOST=localhost
SERVER_PORT=8080
DB_HOST=127.0.0.1
DB=TimeCast
DB_PORT=3306
DB_USER=root
DB_PASSWORD=
DEBUG=FALSE
OFF_DATABASE=TRUE