База данных «Учебная платформа ИнженерыИнформации»
Программное обеспечение (далее ПО) предназначена для повышения экспертности сотрудников за счет структурирования информации и стандартизации качества работы. Платформа помогает специалистам в решении текущих рабочих задач. Новому сотруднику будет проще влиться в процессы, а опытному — прокачать навыки без отрыва от работы. Платформа содержит методические материалы: информацию по новшествам справочно-правовой системы КонсультантПлюс, инструкции, листовки, презентации и обучающие видеоролики.
Инструкция по использованию программного обеспечения
Предназначено для хранения, систематизации и предоставления сотрудникам организации доступа к учебным материалам, нормативным документам и статьям через веб-браузер.
Инструкция по использованию программного обеспечения:
Для начала работы необходимо открыть веб-браузер и перейти по адресу системы. Ввести логин и пароль, выданные администратором, после чего нажать кнопку «Войти».
После входа откроется главный интерфейс, состоящий из двух частей: дерево категорий — слева, список материалов выбранной категории — справа.
Для поиска материала необходимо выбрать нужную категорию в дереве слева либо воспользоваться строкой поиска. Доступные для просмотра и скачивания материалы отображаются в зависимости от прав, назначенных пользователю администратором.
Раздел «Статьи» предназначен для просмотра публикаций, разделённых по тематическим разделам и подразделам (Обзоры, НПА, Волгоград, Письма, Путеводители, Готовые решения).
Административная панель доступна пользователям с правами администратора. Позволяет управлять пользователями, ролями, категориями, материалами, организациями и статьями. Для перехода в административную панель необходимо добавить к адресу системы /admin.html.
Назначение прав доступа осуществляется через раздел «Роли» административной панели. Каждой роли назначается набор разрешений и перечень категорий, к которым предоставляется доступ. Роль назначается пользователю в разделе «Пользователи».
Назначение программного продукта
Программный продукт база данных «Учебная платформа ИнженерыИнформации» предназначен для централизованного хранения, систематизации и предоставления сотрудникам организации доступа к учебным материалам, нормативным документам и тематическим статьям через веб-браузер. Система обеспечивает разграничение доступа по ролям, ведение базы материалов в иерархической структуре категорий, а также публикацию статей с делением на разделы и под-разделы. После размещения материалов администратором сотрудники получают доступ к актуальному перечню документов в соответствии с назначенными правами.
Сфера применения и использования программы
ПО предназначено для сотрудников и руководителей организаций, которым необходим оперативный доступ к учебным и нормативным материалам, а также для администраторов, осуществляющих ведение базы материалов и управление правами доступа пользователей.
Функциональные характеристики
Программный продукт обеспечивает хранение и выдачу файловых материалов по иерархическим категориям с разграничением доступа на основе ролевой модели, публикацию статей с тематической классификацией по разделам и под-разделам, управление пользователями и организациями через административную панель, а также ведение журнала аудита действий пользователей в системе.
Описание технических средств
Язык программирования — JavaScript (Node.js, серверная часть), JavaScript (Vanilla JS, клиентская часть), SQL.
Разработка ведётся локально с использованием системы контроля версий Git. Хранение исходного кода осуществляется на удалённом репозитории GitHub.
Серверная часть реализована на платформе Node.js с использованием фреймворка Express.js. В качестве СУБД используется PostgreSQL. Взаимодействие с базой данных осуществляется через ORM Sequelize. Аутентификация пользователей реализована на основе токенов JWT. Загрузка файлов обрабатывается библиотекой Multer.
Клиентская часть реализована на Vanilla JavaScript без использования сборщиков. Интерфейс построен на CSS-фреймворке Bootstrap 5. Для отображения иерархического дерева категорий используется библиотека jsTree. HTTP-запросы к API выполняются через библиотеку Axios.
Программный продукт разворачивается на сервере под управлением ОС Linux. Запуск и управление серверным процессом осуществляется через менеджер процессов PM2. Доступ пользователей к системе осуществляется через веб-браузер по протоколу HTTPS.
Компиляция не требуется — серверный и клиентский код интерпретируется на уровне платформы Node.js и браузера соответственно.
Инструкция по установке
Программный продукт база данных «Учебная платформа ИнженерыИнформации» не требует установки на стороне пользователя. Доступ осуществляется через любой современный веб-браузер по адресу, выданному администратором системы.
Развёртывание на сервере (выполняется администратором):
Установить на сервер Node.js (версия 18 и выше) и СУБД PostgreSQL.
Скопировать исходный код программного продукта на сервер.
В корневом каталоге создать файл конфигурации .env с параметрами подключения к базе данных, секретным ключом для токенов и номером порта.
Выполнить установку зависимостей командой npm install.
Выполнить инициализацию базы данных командой npm run db:setup.
При обновлении системы выполнить скрипты миграции базы данных из каталога scripts/.
Запустить серверный процесс через менеджер процессов PM2 командой pm2 start server.js.
После запуска система доступна пользователям через веб-браузер по указанному адресу и порту. После запуска система доступна пользователям через веб-браузер по указанному адресу и порту.
Информация о поддержании
Программное обеспечение не требует поддержания работоспособности до внесения критических изменений в серверную инфраструктуру или обновления зависимых программных компонентов.
Информация об эксплуатации и поддержке программного продукта
Для устранения неисправностей, внесения изменений и совершенствования программного обеспечения требуется специалист-программист со знанием языка программирования JavaScript, платформы Node.js, СУБД PostgreSQL, а также базовыми навыками администрирования Linux-сервера.
