Перейти до змісту

ESWF + DOP — Документація проєкту

Що це: єдина точка входу у всю проєктну документацію. Нагорі — два рівні:

  • ESWF — технологічний фреймворк (Django + React + патерни + база)
  • DOP — продукт, побудований на ESWF (Digital Operations Platform)

Як користуватись: натискайте на посилання — IDE відкриває файл, кнопка «назад» повертає сюди. У кінці — секція Backlog, що агрегує ## 🔮 Deferred / Ideas з усіх документів.

Статуси: ✅ реалізовано · ⚠️ частково (ядро є, розширення planned) · ⏳ в роботі · 📋 план (код відсутній) · 💎 платний плагін (поза community) · 💡 ідея · 🗄️ архів


📑 Зміст

  1. 🗂 Три шари документації ← нова структура
  2. Головне
  3. ESWF — Framework
  4. DOP — Product overview
  5. DOP · Horizontal modules
  6. DOP · Vertical modules
  7. DOP · Essentials (деталі)
  8. DOP · Fleet (деталі)
  9. DOP · Integrations
  10. DOP · Features
  11. Планування та дослідження
  12. 🔮 Відкладені ідеї / Backlog

🗂 Три шари документації

Нова організаційна модель (planning/three-layer-docs-strategy.md):

Шар Тека Аудиторія Видимість
1. User Manual user/ бухгалтер, диспетчер, водій публічно
2. Dev Articles dev/ розробник, плагін-автор публічно/CF Access
3. AI Portability Bundle ai/ LLM (Claude/GPT) приватно (CF Access)

Стара структура docs/eswf/ + docs/dop/ мігрує в docs/dev/ поступово, при кожному редагуванні. Працює до кінця міграції.


🏠 Головне

Документ Опис Статус
manifesto.md Маніфест ESWF/DOP — позиція проєкту на пост-1С українському ринку: generic vs specific, wedge, запрошення 1С/BAS-спільноти 📣
todo.md Загальний план/roadmap проєкту (основний backlog) 📋
BACKLOG.md Автогенерований backlog (із ## 🔮 Deferred) 🔄
audit-2026-04-22.md Активний аудит — пост-MVP era + глибинний gap-аналіз 6 блоків Essentials (§7-§9). Inventory P0/P1 закрито у inventory-overhaul-2026-05-09.md 🔍
planning/inventory-overhaul-2026-05-09.md Inventory overhaul — 11 фаз закрито в одну сесію (writeoff posting + dual-currency + L4/L5 + opening balance + InventoryCount + 6 reports + ergonomy actions + currency revaluation + StockTransfer + batch lifecycle + Period Close). 61 тест.
audit-concepts-2026-04-22.md Концептуальний аудит — 15 наскрізних принципів обліку SAP/Odoo/1C/Dynamics для переосмислення підходу (нічне читання) 📚
audit-2026-04-21.md Закритий 2026-04-22 — базовий аудит doc vs impl + Phase A→F-4 виконано 🗄️
CLAUDE.md Контекст для Claude Code: структура, стек, статус компонентів
CONTRIBUTING.md Онбординг нового розробника (Python+JS з нуля, з 1С-аналогіями)
eswf/overview.md ESWF — огляд фреймворку
dop/overview.md DOP — огляд продукту

🏛️ ESWF — Framework

Технологічна основа: стек + архітектурні патерни + базова інфраструктура.

Architecture

Документ Опис
eswf/overview.md Огляд фреймворку: шари, патерни, роадмап
eswf/architecture/data-model.md Зведена ER-картина: базові класи, multi-tenancy, posting bridge, крос-аппові FK
eswf/architecture/audit.md Архітектурний аудит, ризики, рекомендації

Frontends (імплементація сайтів)

Сайт Документ Опис
Portal (eswf.dev) eswf/frontends/portal.md Лендінг Next.js 15 (static export)
News (news.eswf.dev) eswf/frontends/news.md Блог Vite + React 19 + Router 7
DOP-app (erp.eswf.dev) eswf/frontends/dop-app.md Основний DOP React 19 + Mantine 8
Client Portal / Shop (shop.eswf.dev) eswf/frontends/shop.md Клієнтський кабінет Next.js 15 SSR (каталог з Essentials, замовлення, трекінг)
Mobile Driver / Sales eswf/frontends/mobile.md Expo + WatermelonDB (офлайн-sync)

Infrastructure

Документ Опис
eswf/infrastructure/backend.md Backend-імплементація: Django 5 + DRF + Channels
eswf/infrastructure/build.md Збірка/деплой усіх frontend-ів
eswf/infrastructure/docker.md Docker — Dockerfile.demo, nginx, supervisord, поставка колезі
eswf/infrastructure/desktop-installer.md 📋 Desktop Installer — план Windows-інсталятора з ярликом на робочому столі (tarball-based)
eswf/infrastructure/update-delivery.md 📋 ADR Update Delivery — канали релізів (stable/beta/dev), версіонування, manifest, міграції БД, rollback, auto-update agent, сумісність плагінів
eswf/infrastructure/plugin-instruction.md Еталон: як створити платний плагін
eswf/infrastructure/testing.md ✅ Тестова інфраструктура backend: pytest + pytest-django, 58 тестів ядра
eswf/infrastructure/testing-frontend.md ✅ Тестова інфраструктура frontend: Vitest + RTL, 80 тестів (stores, API, utils, LoginPage, ErrorBoundary)
eswf/infrastructure/claude-code.md 📖 Гайд для нового розробника: як користуватися Claude Code у цьому проекті — маршрутизація CLAUDE.md, skills, hooks, memory, практичні прийоми
eswf/infrastructure/seed-methodology.md 📦 Seed-методика: 3 tenants × 14 фаз × ~80 invoices, demo-юзери з ролями (§3-ter), App Store sync

Permissions (RBAC)

Документ Опис
eswf/permissions/README.md 🔐 Оглавлення системи прав: caталог + БД + HasRolePermission + UI editor
eswf/permissions/role-catalog.md Каталог 14 системних ролей з описами, scope, demo-юзерами
eswf/permissions/architecture.md Моделі (Role/RolePermission/UserRole), HasRolePermission, entity resolution, gaps
eswf/permissions/frontend-integration.md useActivePermissions, useFilteredSections, requiresEntities, sidebar gating
eswf/permissions/editing-via-ui.md Admin Tools → Roles Matrix: чекбокси V/C/U/D/P, Save/Discard/Reset to catalog
eswf/permissions/adding-new-entities.md Чек-ліст для нової сутності/модуля — як одразу прив'язати до ролей
eswf/permissions/demo-users.md Усі демо-логіни 3 тенантів з ролями та use-case'ами

🎯 DOP — Product overview

DOP (Digital Operations Platform) — головний продукт, побудований на ESWF.

Документ Опис
dop/overview.md Огляд DOP: модулі, сайти, статус
dop/spec.md Specification: детальна архітектура платформи

🧱 DOP · Horizontal modules

Наскрізні модулі, придатні для будь-якої галузі.

Модуль Документ Статус Опис
Essentials dop/modules/horizontal/essentials/README.md База: довідники + документи + регістри + звіти (P&L, BS, CF)
Inventory & Finance dop/modules/horizontal/essentials/inventory-finance.md Партіонний облік + 2-валютний фін. рух
Accounting & Tax dop/modules/horizontal/accounting-tax/README.md ⚠️ Ядро в Essentials (ChartOfAccounts, PostingGroup+PostingEntry, 4 звіти); розширення (Trial Balance, ОСВ, Форма 1, tax returns, FixedAsset) — planned
— Architecture dop/modules/horizontal/accounting-tax/architecture.md Financial Dimensions (D365-style) замість субконто
— Chart of Accounts dop/modules/horizontal/accounting-tax/accounting-plan.md План рахунків за стандартом European PCG (класи 1–7)
CRM & Sales dop/modules/horizontal/crm-sales/README.md Lead → Deal → контрагент + Pipeline analytics (funnel, win-loss, manager KPI) — Phase D
HRM & Payroll dop/modules/horizontal/hrm-payroll/README.md ⚠️ MVP: Position/Employee/PayrollPeriod/PayrollSlip + payroll posting (Phase F-1). Розширення (Timesheet, KPI, UA-tax) — planned
Production & BOM dop/modules/horizontal/production-bom/README.md ⚠️ MVP: BOM/BOMLine/WorkOrder + complete posting (Phase F-2). Розширення (multi-level BOM, WIP costing, Work Centers) — planned
Client Portal dop/modules/horizontal/client-portal/README.md ⚠️ Реалізовано як окремий Next.js фронтенд frontend/shop/ (shop.eswf.dev): каталог з Essentials, замовлення, transport requests. B2B-розширення (statement of account, individual pricing, reconciliation) — planned
Budgeting dop/modules/horizontal/budgeting/README.md ⚠️ MVP: Budget/BudgetLine + plan-vs-actual variance (Phase F-4). Розширення (multi-version, what-if, forecasting, approval workflow) — planned
Consolidation dop/modules/horizontal/consolidation/README.md ⚠️ MVP: ConsolidationGroup/Member/IntercompanyMap + consolidated P&L з елімінацією внутрішньогрупових оборотів (Phase F-5, 2026-04-23). Розширення (unrealized profit elim, minority interest, мультивалютність, Balance Sheet) — planned
E-Commerce Manager dop/modules/horizontal/commerce/README.md ⚠️ Реалізовано як процес-аддон всередині Essentials (StoreManager/ в ERP + backend/shop/): каталог для Client Portal, activation codes, SMTP. Headless e-commerce engine (LiqPay, Нова Пошта) — planned
Gatehouse dop/modules/horizontal/gatehouse/README.md ⚠️ Sprint 1 shipped (2026-04-28): GatePoint/Equipment/Event/Checkpoint/WeighingTicket з ручним вводом. S2-S5 — hardware bridge + ANPR webcam + correlator + FortNet integration. План: planning/gatehouse-plugin.md

🚚 DOP · Vertical modules

Галузеві модулі, що будуються поверх Horizontal.

Модуль Документ Статус Опис
🚢 ShipCore (umbrella vertical для transport logistics) dop/modules/vertical/shipcore/README.md 📋 Phase 0-1, 2026-05-12+ — лідерська вертикаль для UA+EU транспортної логістики (auto/forwarder/sea/rail/terminal/avia/pricing). Об'єднує Fleet+Logistic+ContainerHub + нові Sea/Rail/Avia під thin shared core backend/shipcore/. 12 архітектурних рішень — у decisions-2026-05-12.md
↳ shipcore_auto (з Fleet) dop/modules/vertical/fleet/README.md ✅ → 📋 refactor у Phase 4 Автопарк (33 моделі ✅), стане shipcore_auto open-source
↳ shipcore_forwarder (з Logistic) dop/modules/vertical/logistic/README.md 💎 → 📋 значне розширення Multimodal F&F (платний плагін, поки stub), стане shipcore_forwarder з повним HBL/MBL/Booking/Carrier APIs
↳ shipcore_terminal (з ContainerHub) dop/modules/vertical/containerhub/README.md ✅ → 📋 refactor Контейнерний термінал (24 моделі ✅), стане shipcore_terminal
↳ shipcore_sea / _rail / _avia / _pricing dop/modules/vertical/shipcore/modules/ 📋 NEW Нові вертикалі (Phase 5-7) + pricing engine на основі planning/truck-freight-pricing-western.md
↳ Containerhub User Guide containerhub/user-guide.md Інструкція користувача (поки до refactor)

💼 DOP · Essentials (деталі)

Деталізація обраних документів та механік базового модуля. Огляд: Essentials README.

Master Data (довідники)

Документ Опис
essentials/nomenclature.md Item, Unit, ItemComponent, ExpenseItem
essentials/partners.md Client, Organization, Person, Department
essentials/contracts.md Contract + ContractSpecification
essentials/prices.md PriceType + ItemPrice — багаторівневе ціноутворення
essentials/finance-accounts.md Cashbox, Bank, SettlementAccount, TaxRate
essentials/currency.md Валютний облік (dual-currency accounting)
essentials/batches.md Партіонний облік (IFRS IAS 2, FIFO + WAC)
essentials/vat.md Облік ПДВ за українським законодавством

Закупки (Purchase-to-Pay)

Документ Опис
essentials/goods-receipt.md Прихідна накладна: порівняння з SAP/D365/1С/Odoo
essentials/purchase-invoice.md Рахунок від постачальника (3-way matching: PO + GR + Invoice)

Продаж (Order-to-Cash)

Документ Опис
essentials/sales-invoice.md Invoice + GoodsShipment — цикл реалізації

Платежі та списання

Документ Опис
essentials/payments.md IncomingPayment + OutgoingPayment + PlannedPayment
essentials/cash-transfer.md CashTransfer — переказ коштів між своїми рахунками (каса↔банк, банк↔банк, каса↔каса). Phase F-6, 2026-04-23
essentials/bank-reconciliation.md BankStatement — імпорт банківських виписок (4 формати), auto-match, Kanban UI. S5 cash-bank-audit, 2026-05-10
essentials/statement-of-account.md Statement of Account (акт звірки) — звіт розрахунків з контрагентом на базі PartyLedger. Phase F-6, 2026-04-23
essentials/writeoffs.md Списання товарів (псування, крадіжка, прострочення)
essentials/quality-control.md QC-аддон: Dock → QC Cage → Stock

Бухгалтерія та звітність

Документ Опис
essentials/accounting-setup.md План рахунків + бізнес-операції
essentials/document-operations.md Універсальні бух. документи
essentials/inventory-finance.md Рух ТМЦ + фінансовий резонанс
essentials/cashflow-reports.md ✅ Журнали, леджери, P&L, Cash Flow, Balance Sheet, Payment Calendar, Trial Balance, P&L Drill-Down, ПСБО Форма 1 (2026-04-22)
essentials/party-ledger.md ✅ PartyLedger — уніфікований регістр дебіторки/кредиторки з direction + running_balance (2026-04-22)
essentials/journal-entry.md ✅ Manual JournalEntry + JournalEntryLine — ручні проводки без документа-джерела з валідацією Σ Дт = Σ Кт (Phase E, 2026-04-22)
essentials/fixed-assets.md ✅ FixedAsset + DepreciationEntry — облік основних засобів з місячною амортизацією (Phase E, 2026-04-22)

🚛 DOP · Fleet (деталі)

Документ Опис
fleet/README.md Огляд Fleet-модуля
fleet/waybill.md Подорожній лист (повні нотатки імплементації)
fleet/driver-salary.md Зарплата водіям (відрядно-преміальна)
fleet/tariffs.md Тарифи на перевезення
fleet/fuel-calculation.md Розрахунок витрати пального

🔌 DOP · Integrations

Документ Опис
integrations/medoc.md ⏳ MedocExchange — інтеграція з M.E.Doc (поки тільки UKTZED довідник)
integrations/gps-wialon.md ✅ Wialon GPS — трекінг ТЗ (платний плагін)
integrations/ettn.md ✅ Електронні ТТН з Ed25519-підписом
integrations/ip-telephony.md ⏳ IP-телефонія SIP/WebRTC (UI-overlay є, live-сценарій до перевірки)
integrations/baf-sync.md ⚠️ BAF Sync — MVP-інфраструктура (Settings + EntityMapping + SyncLog + pluggable transport + dry-run by default) реалізована; реальний httpx-transport — наступна ітерація (Phase F-3, 2026-04-22)
integrations/bank-exchange.md ⚠️ Bank Exchange — імпорт банківських виписок + експорт платіжних доручень (backend+UI частково)
eswf/infrastructure/plugin-instruction.md Еталонна інструкція створення плагіну

✨ DOP · Features

Фічі, які не прив'язані до одного модуля.

Документ Опис
features/ai.md 🧠 AI — огляд (чат, аналітик, агенти по документах і коду)
features/chat.md AI-асистент (OpenRouter) + корпоративний месенджер
features/finance-analyst.md Фінансовий аналітик на базі ESWF-Chat
features/ai-invoice-agent.md Агент «Виписати рахунок з листа» (ідея)
features/printforms.md Друковані форми — Print Framework (Jinja2 + Playwright)
features/store-manager.md App Store + Store Manager (ліцензії, SMTP, активація)
features/backup-recovery.md 📋 Backup & Recovery — резервне копіювання БД (SQLite+PostgreSQL), UI в Admin Tools, self-healing
features/devtools.md DevTools IDE всередині DOP (config-tree editor)
features/tab-keepalive-plan.md Tab Keep-Alive: план Фази 2
features/keep-alive-report.md Keep-Alive tabs — звіт про Фазу 1

📝 Планування та дослідження

Документ Опис
planning/crm-cabinet.md План CRM + кабінет клієнта (зв'язка Shop↔DOP)
planning/ui-latency.md Дослідження UI latency, холодного відкриття списків
planning/module-versioning-and-dependencies.md 📋 План додавання version/channel (всі dev) і helper-ів buildDependencyTree для accordion-сайдбара. Урізаний фронт ADR update-delivery

🔮 Відкладені ідеї / Backlog

Автоматично генерується із секцій ## 🔮 Deferred / Ideas у кожному md-файлі.

Формат запису в модульних файлах:

## 🔮 Deferred / Ideas

### Назва ідеї
**Мотивація:** чому це потрібно
**Чому відкладено:** що блокує / ROI
**Trigger:** за яких умов починати

Агрегат — BACKLOG.md (генерується Python-скриптом _build_backlog.py). Також — основний todo.md.


🗺️ Workflow роботи з документацією

Запуск локально

cd other
npm install                # одноразово
npm run docs:dev           # dev-сервер на http://localhost:5173
npm run docs:build         # статичний білд у .vitepress/dist/
npm run backlog            # регенерувати BACKLOG.md

Додавання нової ідеї

  1. Відкрити потрібний модульний md-файл.
  2. Додати наприкінці секцію ## 🔮 Deferred / Ideas з описом.
  3. Запустити npm run backlog — BACKLOG.md оновиться автоматично.

Деплой документації (майбутнє)

Статичний білд .vitepress/dist/ готовий до публікації на docs.eswf.dev через GitHub Pages / Cloudflare Pages / Nginx.


Останнє оновлення: 2026-04-22 (Phases A → F-4 implemented — CRM analytics, Manual JE, FixedAsset, HRM/Production/BAF Sync/Budgeting MVPs)