====== АННОТАЦИЯ ======

В данном программном документе приведено руководство системного программиста по установке и настройке WEB-интерфейса для управления устройством "бегущая строка".

====== Общие сведения о системе ======


Функциональным назначением системы является интерфейс для администрирования устройств "бегущая строка"
Основные функции системы состоят в администрировании и создании сообщений для устройства "бегущая строка", а так-же управление устройствами.
Для функционирования системы требуется серверная операционная система и node JS. Все зависимости для работы загружаются при помощи node JS автоматически.
 
====== Структура системы ======


Система WEB-интерфейса состоит из комплекса программного обеспечения, необходимого для её выполнения. Для работы необходим запущенный WEB-сервис. При помощи взаимодействия с элементами выполняются HTTP запросы при помощи JSON строк.

====== Настройка системы ======

Подготовка системы к работе делится на несколько этапов, выполнение которых будет рассматриваться на примере системы GNU/Linux Debian 9. 



===== 1 Установка WEB-интерфейса =====

==== Установка пакета NodeJS ====

Для установки необходимо ввести

  curl -sL https://deb.nodesource.com/setup_16.x | sudo bash -
  sudo apt install curl
==== Установка веб сервиса  ====

Для начала необходимо установить git, который позволяет клонировать репозитории с GitHub
Для установки необходимо ввести 
  sudo apt install git
  
После чего можно переходить к клонированию репозитория при помощи команды в необходимой директории.

  git clone https://github.com/Uristrix/admin_panel.git

==== Установка зависимостей ====

Перейдите в корень WEB-интерфейса. /admin_panel
Затем необходимо ввести команду, при условии установленного NodeJS:

  npm install

===== 2 Удалённый доступ к файлам веб-интерфейса =====

Доступ осуществляется так-же, как и к веб-сервису. Если вы устанавливали веб-сервис, по проделывать нижеперечисленные действия не нужно.

Установите SSH
  $ apt-get install openssh-server
Запустите сервис ssh
  $ service ssh start
  
===== 3 Запуск WEB-интерфейса  =====

Перейдите в корень директории WEB-интерфейса и введите команду 
  npm start
  
===== 4 Обязательные изменения в текстах программ =====

1. Откройте в текстовом редакторе файл ./root/admin_panel/.env.

2. Замените в нём:
  * 'REACT_APP_LOGIN' – Замените на логин для входа в панель администратора.
  * 'REACT_APP_PASSWORD' – Замените на пароль для входа в панель администратора.
  * 'REACT_APP_API' – Обязательно замените ip-адрес, по которому осуществляются HTTP запросы.

3. Сохраните изменения


====== Проверка системы ======

Для проведения проверки системы рекомендуется иметь в базе данных набор значений. После чего можно перейти по адресу web-интерфейса, доступного по ссылке http://ip:3000. После чего необходимо ввести логин и пароль. После авторизации появится сам интерфейс. В выпадающем списке слева должны отобразится устройства, сохраненные в базе данных. Справа в списках отобразится список сообщений.


====== Сообщения отображаемые пользователю ======

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