К содержанию
Nika CRM

Документация

Руководство пользователя

Текст открывается прямо на демо — без перехода в GitHub.

Полное руководство по использованию системы управления сервисным центром Nika CRM.

Версия: 2.5
Последнее обновление: 2026-07-27
Соответствие UI: меню и названия как в текущем интерфейсе (navbar + левый сайдбар).

Пошаговый сценарий рабочего дня (вход → заявка → оплата → ЗП → касса):
USER_WALKTHROUGH.md


Содержание

  1. Введение
  2. Установка и первый вход
  3. Обзор интерфейса
  4. Дашборд
  5. Заявки
  6. Клиенты и устройства
  7. Склад
  8. Магазин
  9. Касса и финансы
  10. Зарплата
  11. Отчёты
  12. Настройки
  13. Уведомления CRM
  14. Чат сотрудников
  15. Глобальный поиск
  16. Клиентский портал
  17. Мобильный доступ и PWA
  18. Права доступа и безопасность
  19. Советы и FAQ
  20. Приложения

Отдельно: пошаговый walkthrough рабочего дня.


1. Введение

Nika CRM — веб-система для сервисного центра: заявки на ремонт, клиенты и устройства, склад и закупки, касса, магазин, зарплата, отчёты, внутренний чат и личный кабинет клиента.

Для кого документ

Роль Что читать в первую очередь
Администратор §§ 2, 3, 12, 18
Менеджер / приёмщик §§ 5, 6, 9, 13, 14
Мастер §§ 5, 10, 14
Кладовщик § 7
Клиент (портал) § 16

Рабочая база данных — только PostgreSQL. SQLite в проекте — наследие, не используйте его для новой установки.

Публичная демонстрация: https://demo.nika-sc.ru/ (откроется в новой вкладке).
Исходники OSS: github.com/nika-sc/Nika-Service-CRM (откроется в новой вкладке).


2. Установка и первый вход

2.1. Быстрый старт с PostgreSQL (дамп)

  1. Создайте БД PostgreSQL (например, nikacrm).
  2. Импортируйте database/bootstrap/nikacrm_public_sanitized.sql (подробности — database/bootstrap/README.md).
  3. В .env укажите: env DB_DRIVER=postgres DATABASE_URL=postgresql://USER:PASSWORD@localhost:5432/nikacrm
  4. Установите зависимости (pip install -r requirements.txt) и запустите (python run.py или Docker).

В актуальном bootstrap уже отмечены миграции PostgreSQL 001–010 (включая staff chat и закрепление заявок). После импорта при старте приложения обычно не остаётся неприменённых SQL-миграций из комплекта дампа. Если в репозитории появились более новые файлы в postgres_versions/, они применятся при следующем запуске.

2.2. Вход в CRM

  1. Откройте адрес системы (локально обычно http://127.0.0.1:5000).
  2. Введите логин и пароль → Войти.
  3. На демо/лендинге вход может открываться модальным окном на главной странице.

Демо-учётки OSS / Windows SETUP (пароль для всех — 111111):

Логин Назначение
admin Полный доступ
manager Менеджер
master Мастер
viewer Только просмотр

Смените пароли перед реальной эксплуатацией.

На публичном демо-VPS могут быть отдельные учётки (например, demo_admin) — смотрите текст на лендинге демо-сайта. Это доступ только к демо-базе CRM, не к SSH/ОС сервера.

2.3. Автономная установка на Windows

Офлайн-установщик для Windows 10/11 x64 (встроенные Python 3.12, PostgreSQL 18, демо-база):

  1. Скачайте NikaCRM-Offline-Setup-1.0.4-x64.exe (откроется в новой вкладке)
    или зеркало на demo.nika-sc.ru/downloads/… (откроется в новой вкладке).
  2. Запустите от имени администратора.
  3. Ярлык Nika CRM — Открытьhttp://127.0.0.1:5000.
  4. Войдите демо-учёткой и смените пароль.

Страница релиза: windows-setup-1.0.4 (откроется в новой вкладке).

Поддержка: smelkov2008@yandex.ru, nika-sc@bk.ru, Telegram (откроется в новой вкладке).

2.4. Типичные проблемы входа

Симптом Что проверить
Страница не открывается Сервис запущен? Порт 5000 / nginx? HTTPS у провайдера иногда «зависает» — попробуйте другую сеть / HTTP
«Неверный логин/пароль» Раскладка, Caps Lock, правильная учётка для этой среды
Пустой экран после входа Права роли: у viewer мало разделов — это нормально
502 Bad Gateway Не запущен gunicorn / приложение за nginx

3. Обзор интерфейса

После входа вы видите:

  1. Верхнее меню (navbar) — разделы: Заявки, Клиенты, Склад, Магазин, Касса, Отчёты, Зарплата, Настройки, Портал; поиск; колокольчик уведомлений.
  2. Левый узкий сайдбар — быстрые иконки тех же разделов + Профиль (выход) + Чат.
  3. Рабочая область — страница текущего раздела.

Пункты меню зависят от прав вашей роли. Если раздела нет — его не выдали в настройках прав.

3.1. Соответствие названий меню

В UI URL (ориентир)
Заявки → Список заявок /all_orders
Заявки → Новая заявка /add_order
Клиенты → База клиентов /clients
Склад → Товары / Инвентаризация / Закупки / Движения / Поставщики / Логи /warehouse/...
Магазин → Продажи /shop
Касса → Движение денег / Прибыль / Аналитика / Категории /finance/...
Отчёты → Сводный, Сводка дня, … /reports/...
Зарплата → Дашборд /salary
Настройки /settings
Портал /portal/...
Чат (левый сайдбар) панель поверх страницы

3.2. Профиль и выход

Внизу левого сайдбара: Профиль → выпадающее меню → Выход (и при наличии прав — ссылка на настройки).

3.3. Тема оформления

В интерфейсе доступны темы оформления (в т.ч. тёмная) — переключатель зависит от сборки/настроек шаблона. Тема влияет только на внешний вид, не на данные.

3.4. Мобильное меню

На узком экране верхнее меню сворачивается в кнопку «гамбургер». Левый сайдбар на очень узких экранах может скрываться — пользуйтесь мобильным меню navbar.


4. Дашборд

Где: иконка Nika CRM / главная / (для авторизованного сотрудника).

Обычно показывает сводные виджеты: заявки, финансы, быстрые ссылки. Набор блоков зависит от прав. Если включён публичный лендинг и вы не авторизованы — на / открывается промо-страница, а не дашборд.


5. Заявки

Права: view_orders / create_orders / edit_orders / delete_orders (и связанные).

5.1. Создание заявки

  1. ЗаявкиНовая заявка (/add_order).
  2. Укажите клиента (поиск или создание), устройство, неисправность, мастера, предоплату/комментарий — по полям формы.
  3. Сохраните.

Совет: модель устройства часто поддерживает автоподстановку; новые значения могут создаваться при сохранении.

5.2. Список заявок

ЗаявкиСписок заявок (/all_orders).

Возможности (в зависимости от версии UI):

  • режимы реестр / канбан / журнал;
  • фильтры по статусу, мастеру, дате, поиску;
  • настройка колонок;
  • быстрая смена статуса из таблицы;
  • переход в карточку заявки.

5.3. Закрепление заявок (pins)

В списке заявок можно закрепить заявку (иконка/кнопка «Закрепить» / «Открепить»).

  • Закрепления общие для всех сотрудников (глобальные order_pins).
  • Закреплённые заявки обычно поднимаются вверх списка, чтобы важные заказы не терялись.

Нужны права на работу с заявками; точная видимость кнопки — как в текущем UI списка.

5.4. Карточка заявки

Откройте заявку из списка (/order/<id>). Типичные блоки:

Блок Назначение
Шапка / статус Смена статуса, печать, основные действия
Клиент и устройство Контакты, техника
Услуги Работы по прайсу
Запчасти Со склада; списание при добавлении
Оплаты Приём оплаты, возвраты
Комментарии Внутренние и/или для истории
Задачи / дедлайны Контроль работ (если включено)

5.5. Смена статуса

  1. На карточке или в списке нажмите кнопку текущего статуса.
  2. Выберите новый статус.
  3. Дождитесь уведомления об успехе.

Набор статусов настраивается в Настройки → Статусы заявок. У статуса могут быть флаги (например, «начисляет зарплату»): при первом переходе в такой статус зарплата по заявке начисляется один раз (повторное «закрыл → открыл → закрыл» не должно дублировать начисление).

5.6. Услуги и запчасти

Услуги: «Добавить услугу» → выбрать из справочника → количество/цена → добавить.

Запчасти: поиск по названию/артикулу → количество → добавить. Количество списывается со склада. Если остатка нет — система сообщит об ошибке.

5.7. Оплаты, возвраты, депозит

Добавить оплату

  1. Раздел Оплаты на карточке заявки.
  2. Сумма, способ (наличные / карта / перевод и т.д.), комментарий.
  3. Добавить — создаётся кассовая операция (при обычной оплате).

Прогресс оплаты ограничен 100% (переплата в прогресс не «раздувает» процент).

Возврат оплаты (обычно права менеджера/финансов):

  1. У оплаты нажмите Возврат.
  2. Сумма ≤ остатка оплаты, причина обязательна.
  3. Создаётся возвратный платёж и расход в кассе.

Депозит клиента ведётся в карточке клиента (кошелёк). В интерфейсе заявки депозитные операции могут быть ограничены/отключены — используйте карточку клиента и кассу по актуальному UI.

5.8. Комментарии и задачи

  • Комментарии: внутренние пометки; часть из них не попадает в печатные квитанции клиенту (так и помечено в форме).
  • Задачи/дедлайны: создавайте сроки работ, отмечайте выполнение (если модуль доступен в вашей сборке).

5.9. Печать документов

На карточке заявки доступны:

  • Квитанция клиенту;
  • Товарный чек;
  • Акт выполненных работ.

Шаблоны HTML настраиваются в Настройки → Формы для печати.

Печать при закрытии заявки задаётся параметром close_print_mode в настройках:

Режим Поведение
choice Показать выбор (чек / акт / оба)
sales_receipt Сразу товарный чек
work_act Сразу акт
both Сразу оба
none Не печатать автоматически

5.10. Скрытие заявки

Если в UI есть действие «скрыть» — заявка убирается из обычного списка без физического удаления. Удаление (если разрешено правом delete_orders) — необратимее; уточняйте политику компании.

5.11. Частые ошибки

Проблема Решение
Нет кнопки «Новая заявка» Нет права create_orders
Не списывается запчасть Нет остатка / нет права склада
Не меняется статус Нет права редактирования / статус удалён из справочника
Не печатается шаблон Не заполнен HTML в «Формах для печати»

6. Клиенты и устройства

Права: view_customers (+ права на создание/редактирование по ролям).

6.1. База клиентов

КлиентыБаза клиентов (/clients): поиск, фильтры, переход в карточку.

6.2. Карточка клиента

  • Контакты, комментарии;
  • список устройств и заявок;
  • кошелёк / депозит (пополнение, история);
  • пароль доступа в клиентский портал (если выдаёте ЛК).

6.3. Создание и редактирование

  1. Создайте клиента из базы или прямо из формы новой заявки.
  2. Редактирование — в карточке клиента → сохранить.
  3. Устройство: добавьте к клиенту (тип, бренд, модель, серийный номер и т.д.).

6.4. История устройства

Из карточки устройства / клиента откройте историю ремонтов — все связанные заявки.


7. Склад

Права: view_warehouse / manage_warehouse.

7.1. Товары

СкладТовары (/warehouse/parts или /warehouse):

  • список, поиск, остатки, цены;
  • создание / редактирование карточки товара;
  • оприходование и списание (с причиной);
  • удаление / восстановление (если предусмотрено).

7.2. Категории товаров

Управление категориями — из раздела склада или связанных экранов списка товаров (по текущему UI).

7.3. Закупки

СкладЗакупки (/warehouse/purchases) — рабочий журнал закупок у поставщиков:

  1. Создайте закупку, укажите поставщика и позиции.
  2. Проверьте количества и суммы.
  3. Завершите (complete) — товары поступят на склад; финансовые последствия зависят от настроек/кассы.

Отчёт по закупкам смотрите также в Отчёты → Закупки (/reports/purchases).

7.4. Движения и логи

  • Движения — журнал приходов/расходов по складу.
  • Логи склада — детальный аудит действий.

7.5. Поставщики

СкладПоставщики: справочник контрагентов для закупок.

7.6. Инвентаризация

СкладИнвентаризация:

  1. Создайте сессию инвентаризации.
  2. Внесите фактические количества.
  3. Зафиксируйте расхождения (оприходование/списание по результату).

7.7. Частые ошибки

Проблема Решение
Отрицательный остаток Проверьте списания в заявках и магазине
Закупка не двигает склад Не завершена / ошибка валидации позиций
Нет пункта «Закупки» Нет прав склада или старая роль без пункта меню

8. Магазин

Права: view_shop / manage_shop.

МагазинПродажи (/shop) — быстрые продажи без полноценной «заявки на ремонт»:

  1. Добавьте товары в чек.
  2. Укажите оплату.
  3. Проведите продажу — списание со склада + касса.
  4. При необходимости распечатайте товарный чек (шаблон из настроек).

История и детали продажи — в том же разделе магазина.


9. Касса и финансы

Права: view_finance / manage_finance.

В верхнем меню раздел называется «Касса» (не «Финансы»).

9.1. Движение денег

КассаДвижение денег (/finance/cash):

  • приходы и расходы;
  • переводы между кассами/счетами (если настроено);
  • связь с документами: «Заявка #…», «Чек #…».

9.2. Прибыль и аналитика

  • Касса → Прибыль (/finance/profit);
  • Касса → Аналитика (/finance/analytics).

Дополнительно аналогичные срезы есть в Отчётах.

9.3. Категории (статьи)

Касса → Категории или Настройки → Статьи доходов и расходов (/finance/categories):

  • доходы / расходы;
  • часть категорий системные — их нельзя удалить, только править название/описание.

9.4. Дисциплина кассы

  1. Все оплаты по заявкам и магазину проводите через интерфейс — тогда отчёты сходятся.
  2. Ручные операции помечайте понятным комментарием.
  3. Возвраты оформляйте через «Возврат», а не «минус вручную без связи».

10. Зарплата

Права: salary.view (+ права отчётов при необходимости).

10.1. Дашборд зарплаты

ЗарплатаДашборд зарплаты (/salary):

  • начисления по сотрудникам/периоду;
  • правила и статусы (зависят от настройки статусов заявок и ролей).

10.2. Отчёты по зарплате

  • Зарплата → Отчёт по зарплате или Отчёты → Зарплата (/reports/salary);
  • Отчёты → Долги по зарплате (/reports/salary-debts).

10.3. Личный кабинет сотрудника по зарплате

При наличии маршрутов вида /salary/employee/<id>/<role> сотрудник/руководитель может смотреть детализацию начислений. Доступ ограничен правами.

10.4. Важно про статусы

Зарплата по заявке обычно начисляется при переходе в статус с флагом «начисляет зарплату» один раз. Не «дёргайте» статус туда-сюда без необходимости.


11. Отчёты

Права: view_reports (отдельные отчёты могут требовать доп. прав).

Откройте Отчёты в navbar или левом сайдбаре. Внутри страниц отчётов — боковое меню.

11.1. Карта отчётов

Пункт меню URL Зачем
Сводный /reports/dashboard Общая картина
Сводка дня /reports/day Оперативка за день (директор/управляющий)
Прибыль /reports/profit Прибыльность
Товары и Услуги (аналитика) /reports/analytics Срезы по товарам/услугам
Касса /reports/cash Движения денег
Продажи /reports/sales Продажи
Закупки /reports/purchases Анализ закупок
Маржинальность /reports/profitability Маржа
Статьи /reports/categories По статьям Д/Р
Клиенты /reports/customers Клиентская аналитика
Остатки /reports/stock Складские остатки
Журнал заявок /reports/orders-log История изменений заявок
Логи действий / Журнал действий /reports/action-logs Аудит действий пользователей
Зарплата /reports/salary ФОТ
Долги по зарплате /reports/salary-debts Задолженности
Демо: онлайн /reports/demo-visitors Только если включён DEMO_VISITOR_STATS и вы admin

11.2. Как пользоваться отчётом

  1. Выберите период и фильтры.
  2. Дождитесь пересчёта.
  3. При необходимости экспортируйте (если кнопка есть в UI).

11.3. Демо-статистика посещений

На демо-стенде с DEMO_VISITOR_STATS=1:

  • в navbar у admin может быть чип «Онлайн: N»;
  • отчёт Демо: онлайн показывает сессии, IP, логины;
  • онлайн считается по браузеру (не по одному логину demo_admin): Chrome + Firefox = 2 онлайн.

В обычном продовом контуре этот блок отсутствует.


12. Настройки

Права: в основном manage_users / manage_settings / manage_statuses / роль admin.

Откройте Настройки. Слева — сайдбар разделов.

12.1. Карта настроек

Пункт Назначение
Общие настройки Организация, параметры системы, режим печати при закрытии и др.
Статусы заявок Справочник статусов и флаги
Формы для печати HTML квитанции, товарного чека, акта
Статьи доходов и расходов Ссылка на /finance/categories
Данные об устройстве Справочники типов/брендов/моделей
Услуги Прайсовые услуги
Сотрудники Учётки сотрудников (/settings/employees)
Права пользователей Индивидуальные права (/settings/user-permissions, admin)
Права доступа Матрица прав
Роли Ролевая модель
Уведомления сотрудникам Триггеры для staff
Уведомления клиентам Сообщения клиентам / портал
Уведомления директору Дайджесты/алерты руководителю

12.2. Статусы

Настройте цвета, порядок, флаги (закрывающая, начисляет зарплату и т.д.). Неудаление используемых статусов может быть ограничено системой.

12.3. Формы для печати

Редактируйте HTML-шаблоны и теги полей (список тегов показан на странице настроек). После правок проверьте печать на тестовой заявке.

12.4. Сотрудники и права

  1. Создайте сотрудника, задайте роль и пароль.
  2. При необходимости уточните права в Права пользователей / Права доступа.
  3. Права manage_users и управление критичными настройками оставляйте только админам.

13. Уведомления CRM

  1. Колокольчик в правом верхнем углу navbar — список непрочитанных.
  2. Отметить все как прочитанные / ссылка Все уведомления.
  3. Типы и каналы настраиваются в § 12 (три раздела уведомлений).

Не путайте колокольчик CRM с кнопкой 🔔 в шапке чата сотрудников (это уведомления браузера о сообщениях чата).


14. Чат сотрудников

Внутренний мессенджер для команды.

14.1. Как открыть

Кнопка «Чат» в левом сайдбаре (под профилем / в общем столбце меню).
Раньше могла быть плавающая кнопка справа внизу — в актуальном UI чат открывается из сайдбара.

При непрочитанных входящих:

  • иконка/подпись чата подсвечиваются;
  • красный бейдж с числом пропущенных сообщений.

14.2. Первый запуск

  1. Откройте чат.
  2. Укажите подпись «Кто вы на этом ПК» и сохраните (важно, если за одним логином работают несколько человек/браузеров).
  3. Пишите сообщения, прикрепляйте файлы (лимиты указаны в панели: число файлов и размер).

14.3. Возможности

  • история сообщений, реакции/эмодзи (если включено);
  • индикатор «прочитано»;
  • звук входящего;
  • 🔔 — разрешение уведомлений браузера;
  • 📡 Web Push — если на сервере настроены VAPID-ключи (уведомления при закрытой вкладке).

Чат использует Socket.IO. Если сокет недоступен, возможен ограниченный режим (polling) — в статусе панели будет предупреждение.

14.4. Кому виден чат

Пользователям с правами на основные рабочие модули (заявки/склад/касса/магазин/зарплата и т.п. — как в коде доступа к виджету). Гостям портала чат сотрудников не доступен.


15. Глобальный поиск

Поле поиска в центре navbar: заявки, клиенты, товары…

  1. Начните вводить запрос — появится автодополнение.
  2. Enter / стрелка — переход на страницу результатов /search?q=....

Ищите по номеру заявки, ФИО, телефону, артикулу — в зависимости от индексов и прав.


16. Клиентский портал

Личный кабинет клиента (не путать с входом сотрудника в CRM).

16.1. Вход клиента

  1. Портал в меню или URL /portal/login.
  2. Логин/пароль, выданные клиенту в карточке клиента CRM.
  3. После входа — дашборд /portal/dashboard.

16.2. Разделы портала

Раздел URL Содержание
Дашборд /portal/dashboard Сводка
Мои заявки /portal/orders Статусы ремонтов
Платежи /portal/payments История оплат
Кошелёк /portal/wallet Депозит
Мои устройства /portal/devices Техника клиента и связанные заказы

16.3. Что клиент не видит

Внутренние комментарии, закупочные цены, зарплату, настройки, чат сотрудников, чужие клиенты.

16.4. Для администратора

В карточке клиента задайте/сбросьте пароль портала. Объясните клиенту, что это отдельный вход от CRM сотрудников.


17. Мобильный доступ и PWA

  1. Откройте CRM в мобильном браузере (Chrome / Safari).
  2. При поддержке PWA: «Добавить на главный экран».
  3. Работайте через адаптивное меню.

Реалистичные ожидания

  • Это веб-приложение, не полноценный native offline.
  • Service Worker кэширует ограниченный набор ресурсов; без сети полноценная работа с заявками/кассой не гарантируется.
  • Push для чата зависит от настройки VAPID на сервере и разрешения браузера.

18. Права доступа и безопасность

18.1. Как устроены права

Каждому действию соответствует permission (например, view_orders, manage_warehouse). Роль задаёт набор прав; admin может уточнять индивидуально.

18.2. Рекомендации

  1. Не работайте ежедневно под admin, если достаточно менеджера.
  2. manage_users / критичные настройки — только доверенным лицам.
  3. На демо с публичным паролем считайте данные учебными; не храните там боевые ПДн.
  4. Меняйте пароли после установки Windows SETUP / импорта bootstrap.
  5. Делайте бэкапы PostgreSQL (pg_dump) по расписанию.

18.3. Публичный демо-логин и безопасность сервера

Логин CRM (не SSH). Им нельзя войти на сервер по SSH и нельзя напрямую открыть PostgreSQL из интернета (на нормально настроенном стенде БД слушает localhost). Риск публичного пароля — полный доступ к содержимому демо-CRM.


19. Советы и FAQ

Как быстро найти заявку? Глобальный поиск или фильтры в /all_orders; закрепите важные pins.

Почему нет склада в меню? Нет прав view_warehouse / manage_warehouse.

Касса не сходится с отчётом. Ищите ручные правки, незавершённые возвраты, операции без документов.

Чат без красного бейджа. Панель открыта (счётчик сбрасывается) или вкладка в фокусе; закройте чат и получите сообщение с другого браузера.

HTTPS «не открывается», HTTP открывается. Часто путь/MTU провайдера; проверьте с мобильного интернета или другой сети.

Куда писать по установке Windows? См. контакты в § 2.3.


20. Приложения

20.1. Глоссарий

Термин Смысл
Заявка Заказ на ремонт/услугу
Pins Глобальное закрепление заявки в списке
Касса Денежные движения и связанные отчёты
Портал ЛК клиента
Staff chat Внутренний чат сотрудников
Bootstrap SQL Стартовый дамп PostgreSQL без боевых ПДн

20.2. Карта основных URL

/                    дашборд или лендинг
/login               вход сотрудника
/all_orders          список заявок
/add_order           новая заявка
/order/<id>          карточка заявки
/clients             клиенты
/warehouse/parts     товары
/warehouse/purchases закупки
/shop                магазин
/finance/cash        движение денег
/salary              зарплата
/reports/dashboard   сводный отчёт
/reports/day         сводка дня
/reports/orders-log  журнал заявок
/reports/demo-visitors  демо-онлайн (если включено)
/settings            настройки
/search              поиск
/portal/login        вход клиента
/portal/devices      устройства клиента

20.3. Связанные документы

На демо: /docs (откроется в новой вкладке) (руководства без GitHub).

20.4. История документа

Версия Дата Изменения
2.4 2026-04-10 Предыдущая редакция
2.5 2026-07-27 Актуализация под UI: сайдбар-чат, pins, закупки, сводка дня, журнал заявок, формы печати, портал «Мои устройства», демо-онлайн, термины меню, PostgreSQL 001–010
2.5.1 2026-07-27 Ссылки на walkthrough и оглавление docs; устаревшие overview/аудиты вынесены из docs/
2.5.2 2026-07-27 История изменений README: блоки май–июль 2026
2.5.3 2026-07-27 Публичные страницы /docs на демо; удалены OSS_* и Идеи.txt

Nika CRM — для сервисных центров. Вопросы по продукту и установке: контакты в § 2.3.