CRM-система «Планшет»

Версия 2.0.0

Официальная документация по установке, настройке и эксплуатации

Наименование соответствует свидетельству Роспатента: CRM-система «Планшет»
Руководство пользователя (PDF) Техническая документация (PDF)

Оглавление документации

1. Функциональные характеристики

1.1. Назначение системы

Программное обеспечение CRM-система «Планшет» предназначено для автоматизации управления компаниями, проектами и задачами. Система обеспечивает централизованное хранение информации о клиентах, проектах, документах, а также контроль исполнительской дисциплины.

1.2. Объекты автоматизации

  • Бизнес-процессы управления проектами и задачами
  • Взаимодействие с клиентами (CRM)
  • Документооборот и файловое хранилище
  • Календарное планирование
  • Контроль исполнительской дисциплины

1.3. Детальное описание функциональных возможностей

Модуль Функция Описание Роли с доступом
Управление компанией Создание профилей Создание и редактирование профилей компаний Администратор
Управление компанией Управление сотрудниками Добавление сотрудников, назначение ролей Владелец компании
Управление компанией Визуализация структуры Интерактивная схема иерархии и связей Владелец компании
Проекты и задачи Создание проектов Создание проектов с указанием сроков, бюджета, ответственных Владелец компании
Проекты и задачи Управление задачами Создание, назначение, контроль задач внутри проектов Владелец компании, Менеджер
Проекты и задачи Роли в проекте Назначение ролей: Руководитель, Исполнитель, Наблюдатель Владелец компании, Менеджер
Проекты и задачи Пул задач Фильтрация задач по статусам (В работе, Завершенные, Просроченные) Владелец компании
Проекты и задачи Чек-листы Создание чек-листов и подзадач внутри основных задач Все пользователи
Проекты и задачи Коммуникация Встроенный чат внутри каждой задачи Все пользователи
Календарь Личный календарь Планирование личных событий и встреч Все пользователи
Календарь Корпоративный календарь Общие события компании, собрания, дедлайны Владелец компании
Календарь Timeline Визуализация сроков задач на временной шкале Все пользователи
CRM База клиентов Добавление и редактирование контрагентов Все пользователи
CRM Поиск по ИНН Автоматический поиск и заполнение реквизитов по ИНН Все пользователи
Файловое хранилище Загрузка файлов Загрузка документов компании в хранилище Владелец компании, назначенный сотрудник
Файловое хранилище Права доступа Настройка прав доступа к файлам и папкам Администратор, Менеджер
Техподдержка Обратная связь Встроенный модуль для связи с поддержкой Все пользователи

1.4. Стек технологий

PHP 8.1+ (Laravel 10.x) JavaScript ES6+ (Vue.js 3.x) Inertia.js MySQL 8.0+ Node.js 18+ NPM 9+ Laravel Sanctum (аутентификация)

2. Информация для установки

Важно: Все компоненты ПО используют открытые лицензии (MIT, BSD), не накладывающие ограничений на распространение в РФ. Полный список зависимостей (SBOM) доступен по ссылке.

Вариант А: Облачное использование (SaaS)

Установка на оборудование пользователя не требуется. Доступ через Интернет.

Требования к рабочему месту:

  • Веб-браузер: Chrome 80+, Firefox 90+, Safari 15+, Яндекс.Браузер 22+
  • Подключение к Интернет (скорость от 5 Мбит/с)
  • ОС: Windows 10+, macOS 11+, Linux, iOS 14+, Android 10+
  • Разрешение экрана: от 1280x720

http://109.107.189.165/

Вариант Б: Локальная установка

Системные требования (сервер):
  • • Процессор: 2 ядра, 2+ GHz
  • • ОЗУ: 4 GB (рекомендуется 8 GB)
  • • Диск: 20 GB SSD
  • • ОС: Ubuntu 20.04+ / Debian 11+ / CentOS 8+
Программные требования:
  • • PHP >= 8.1 (с расширениями: BCMath, Ctype, JSON, Mbstring, OpenSSL, PDO, Tokenizer, XML)
  • • Composer 2.x
  • • Node.js 18+ & NPM 9+
  • • MySQL 8.0+ или PostgreSQL 14+
  • • Nginx / Apache
# Полная инструкция по установке:
# 1. Клонирование репозитория
git clone https://github.com/miki3074/crmcrm.git /var/www/crm
cd /var/www/crm
# 2. Установка зависимостей PHP
composer install --no-dev --optimize-autoloader
# 3. Установка зависимостей JS
npm install && npm run build
# 4. Настройка окружения
cp .env.example .env
php artisan key:generate
# 5. Настройка .env файла:
DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=crm_db
DB_USERNAME=crm_user
DB_PASSWORD=secure_password
# 6. Миграции и наполнение БД
php artisan migrate --force
php artisan db:seed --force
# 7. Настройка веб-сервера
# Настройте корневую директорию на /var/www/crm/public
# Пример для Nginx в документации администратора (PDF)
# 8. Запуск
php artisan optimize
# Настройте supervisor для queue:work

3. Информация для эксплуатации

3.0. Общие сведения

Для начала работы в системе необходимо пройти авторизацию. Система поддерживает три роли пользователей с разными уровнями доступа:

  • Сотрудник - базовый доступ, работа с задачами, календарем, CRM
  • Менеджер - назначение задач, управление клиентами
  • Администратор - полный доступ, управление пользователями, настройки системы
Руководство пользователя
Менеджер

3.1. Интерфейс и навигация

Главное меню

Расположено вверху, содержит разделы: Календарь, Клиенты, Хранилище, Схема, Сотрудники,.

Верхняя панель

Уведомления, поиск по системе, профиль пользователя, быстрый переход.

Рабочая область

Основная область для работы с выбранным разделом.

3.4. Возможные ошибки и способы их устранения

Код/Тип ошибки Описание Причина Решение
401 Unauthorized Ошибка авторизации Сессия истекла, неверные cookies Выйти и заново авторизоваться. Очистить cookies браузера.
403 Forbidden Нет доступа к разделу У пользователя недостаточно прав Обратиться к администратору для изменения роли.
404 Not Found Страница не найдена Неверный URL, объект удален Проверить правильность ссылки, обновить страницу.
419 Page Expired CSRF-токен истек Долгая бездействие на форме Обновить страницу и отправить форму заново.
500 Internal Server Внутренняя ошибка сервера Проблемы на стороне сервера Сообщить администратору. Проверить логи в storage/logs.
502 Bad Gateway Ошибка соединения Проблемы с сервером, перезагрузка Подождать 1-2 минуты и обновить страницу.
Ошибка загрузки файла Файл не загружается Превышен размер, неверный формат Проверить ограничения: макс. размер 100MB, форматы: jpg, png, pdf, doc, xls, zip.
Ошибка поиска по ИНН Данные не загружаются Некорректный ИНН, проблемы с внешним API Проверить ИНН (10/12 цифр). Заполнить реквизиты вручную.

4. Глоссарий (словарь терминов)

Компания - юридическое лицо или ИП, зарегистрированное в системе, основная единица учета.
Проект - совокупность задач, объединенных общей целью, сроками и бюджетом.
Задача - единица работы, имеющая исполнителя, срок и статус выполнения.
Подзадача - часть задачи, элемент чек-листа.
Роль - набор прав доступа пользователя в системе.
Администратор - пользователь с полными правами на управление системой.
Менеджер - пользователь, управляющий проектами и задачами.
Сотрудник - пользователь с базовыми правами исполнителя.
Дедлайн - крайний срок выполнения задачи.
Чек-лист - список подзадач внутри основной задачи.
Пул задач - общий список всех задач с возможностью фильтрации.
Контрагент - клиент или партнер компании.
ИНН - идентификационный номер налогоплательщика.
API - программный интерфейс для интеграции с другими системами.