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

Добре дошли в пълната документация за Lager Guru, система за управление на складове и оркестрация на транспорт от корпоративен клас.

Бърз старт

• Въведение - Какво е Lager Guru?
• Тур на продукта - Ръководен тур на функциите
• Основни функции - Пълен списък с функции
• Архитектура - Системна архитектура
• Ръководство за разгръщане - Разгръщане в производство
• API справка - TypeScript API документация
• Отстраняване на проблеми - Често срещани проблеми и решения

Функции

Основна функционалност

• Многоролева система: Роли Администратор, Шофьор, Работник с контрол на достъпа на базата на роли
• Актуализации в реално време: Supabase Realtime за синхронизация на данни в реално време
• Поддръжка на PWA: Инсталируемо, офлайн-способно прогресивно уеб приложение
• Сканиране на баркод: Сканиране на баркод на базата на камера за бързо търсене на поръчки
• GPS проследяване: Проследяване на местоположението на шофьори в реално време на интерактивна карта
• AI предложения: Интелигентни препоръки за назначаване на шофьори и зони
• Управление на смени: Седмично/месечно планиране на смени с шаблони, автоматична синхронизация на статус и анализи
• Анализи: KPI в реално време и разширени отчети, включително проследяване на часове на смени

Корпоративни модули

• Инвентар / Управление на наличност: Пълно проследяване на инвентара с движения на наличност
• Pick & Pack: Комисиониране и опаковане в стил Enterprise WMS
• Складова карта: Визуализация на разположение на зони на базата на SVG
• AI за оптимизация на разположение: Интелигентни препоръки за разположение на зони
• Модул за поддръжка: Проследяване на поддръжка на оборудване
• Безопасност и съответствие: Докладване на инциденти и анализи
• Проследяване на оборудване: Проследяване на местоположение на оборудване с QR/RFID/ръчно
• Двигател за автоматично назначаване: Интелигентно назначаване на шофьори и зони

Вижте Корпоративни модули за подробна документация.

Технологичен стек

• Frontend: React 18 + TypeScript + Vite
• UI: shadcn/ui + Tailwind CSS
• Backend: Supabase (PostgreSQL + Realtime + Auth)
• Карти: MapLibre GL
• Диаграми: Recharts
• Разгръщане: Docker + Nginx

Начало

Предварителни изисквания

• Node.js 18+
• npm или yarn
• Supabase акаунт
• Docker (за разгръщане)

Инсталация

# Клониране на хранилище
git clone https://github.com/your-org/lager-guru.git
cd lager-guru

# Инсталиране на зависимости
npm install

# Настройване на променливи на средата
cp .env.example .env
# Редактиране на .env с вашите Supabase идентификационни данни

# Стартиране на сървър за разработка
npm run dev

Разработка

# Изпълнение на сървър за разработка
npm run dev

# Компилиране за производство
npm run build

# Преглед на компилация за производство
npm run preview

# Генериране на документация
npm run docs:dev
npm run docs:build

Структура на документацията

docs/
├── overview/            # Преглед и въведение на продукта
├── features/            # Корпоративни модули и функции
├── admin/               # Ръководства и конфигурация за администратор
├── users/               # Ръководства за потребители (работници, шофьори)
├── product/            # Информация за продукта (цени, издания, ЧЗВ)
├── api/                 # API документация
├── database/            # Справка за база данни
├── development/         # Ръководства за разработчици
├── integrations/        # Ръководства за интеграция
├── enterprise/          # Корпоративни операции
├── security/            # Документация за сигурност
├── deployment/          # Ръководства за разгръщане
├── multitenant/         # Многопотребителска архитектура
├── sso/                 # SSO интеграция
└── changelog/           # Бележки за издаване

Принос

При добавяне на нови функции или компоненти:

1. Добавете JSDoc коментари към вашия TypeScript/React код
2. Актуализирайте съответната документация в папката docs/
3. Изпълнете генериране на документация: npm run docs:generate
4. Прегледайте промените: npm run docs:dev

Ресурси

• Основен README - Преглед и настройка на проекта
• Ръководство за инсталация - Подробни стъпки за инсталация
• Runbook - Оперативни процедури
• Ръководство за поддръжка - Контролен списък за поддръжка

Поддръжка

За проблеми и въпроси:

• Проверете Отстраняване на проблеми
• Прегледайте Runbook
• Отворете проблем в GitHub

---

Последна актуализация: 2025-12-07