ТРЕБОВАНИЯ К КВАЛИФИКАЦИИ ПОЛЬЗОВАТЕЛЯ

Для установки сервиса «Clientype» пользователь должен обладать следующими компетенциями:

• умение использовать командную строку;
• опыт установки пакетов командной строки;
• представление о назначении Docker инфраструктуры.

2. ТЕХНИЧЕСКИЕ (АППАРАТНЫЕ) И ПРОГРАММНЫЕ ТРЕБОВАНИЯ

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

• 2 vCPU x86
• 32 Гб ОЗУ
• 80 Гб HDD

Требования к программным средствам для корректной работы серверной части сервиса:

• Одна из операционных систем: Ubuntu версии 14.04.5 или выше, Linux Mint версии 17.3 или выше, Arch Linux, Manjaro, Fedora 24 или выше, openSUSE Leap версии 42.1 или выше, MacOS-X, Windows версии 8 или выше.
• В операционной системе должна быть установлена платформа Docker.

Web-интерфейс сервиса «Clientype» не содержит особых технических (аппаратных) требований для эксплуатации.

Требования к программным средствам для корректной работы web-интерфейса сервиса:

• Web-браузер Mozilla Firefox (112.0 и выше) или Google Chrome (112 и выше).

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

• Приложение Telegram последней версии.

3. ОКРУЖЕНИЕ РАЗВЕРТЫВАНИЯ ПРОГРАММНОГО ОБЕСПЕЧЕНИЯ

Сервис «Clientype» поставляется в Docker-контейнерах, организованных системой Docker compose. Конфигурация контейнеров описана в файле docker-compose.yml в корневой папке проекта:

• Web: клиентская часть
• Backend: серверная часть
• Bot: серверная часть для взаимодействия с Telegram-ботом

Для установки всех необходимых программ достаточно развернуть контейнеры при помощи Docker compose, находясь в корневой папке проекта. В результате станут доступны все необходимые для работы сервиса программы:

1. для функционирования серверной части:

• среда исполнения Python, специфичная для операционной системы (либо платформы) конечного пользователя
• dostoevsky==0.6.0
• morpholog==1.6
• numpy==1.19.5
• pandas==1.3.5
• pingouin==0.3.11
• pymorphy2==0.9.1
• pymystem3==0.2.0
• seaborn==0.11.2
• simple-elmo==0.8.0
• snowballstemmer==2.1.0
• spacy==3.0.6
• stanza==1.2
• tensorflow==2.5.0
• termcolor==1.1.0
• uvicorn==0.22.0
• fastapi==0.95.1
• requests==2.30.0
• wordfreq==2.5.0

2. для функционирования клиентской части (web-приложения):

• интерпретатор Node.js последней версии
• @chatscope/chat-ui-kit-react: ^1.10.1,
• @types/node: 18.15.3,
• @types/react: 18.0.28,
• @types/react-dom: 18.0.11,
• eslint: 8.36.0,
• eslint-config-next: 13.2.4,
• next: 13.2.4,
• js: ^2.20.0,
• js-dist-min: ^2.20.0,
• react: 18.2.0,
• react-dom: 18.2.0,
• react-loader-spinner: ^5.3.4,
• react-plotly.js: ^2.6.0,
• react-query: ^3.39.3,
• io: ^4.6.1,
• typescript: 5.0.2

4. УСТАНОВКА И ЗАПУСК

Для установки необходимых пакетов и запуска сервиса потребуется выполнить следующие шаги:

1. Для подтверждения того, что Docker установлен в системе и/или для проверки версиb, в командной строке можно выполнить команды docker —version.
2. Скачать файлы установки сервиса «Clientype» по сылке, с последней версией Docker для соответствующей операционной системы.
3. Если потребовалось выполнить п.2, после его исполнения следует повторить п.1.
4. В командной строке перейти в корневой каталог сервиса, содержащий файл docker-compose.yml, и выполните следующую команду:

docker-compose up -d

Где:

-d: Запустить контейнеры в фоновом режиме.

Это команда запустит контейнеры в соответствии с конфигурацией, определенной в файле docker-compose.yml.

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