Kazem Alghasi 6aee0324d4 docs(docs): overhaul project documentation and deployment guides

Refactor all primary documentation files to improve readability,
visual presentation, and technical accuracy.

- Update `README.md` with a modern layout, including technology badges
  and a high-level architecture overview.
- Redesign `04_Laravel/README.md` to include a streamlined installation
  guide, environment configuration details, and default credentials.
- Revamp `DEPLOYMENT.md` to provide clear, environment-specific
  instructions for production and local setups.

2026-08-28 22:40:44 +03:30

11 KiB

Raw Blame History

🚀 IFNEX Logistics Management System

پلتفرم جامع مدیریت لجستیک بین‌المللی

جایگزینی فرآیندهای دستی مبتنی بر اکسل با معماری Headless مدرن

📚 مستندات • ⚡ شروع سریع • 🏗️ معماری • 📞 پشتیبانی

📖 درباره پروژه

IFNEX یک راه‌حل جامع برای شرکت‌های حمل‌ونقل بین‌المللی است که فرآیندهای مبتنی بر فایل‌های اکسل را با یک سیستم Headless مدرن جایگزین می‌کند.

این سیستم شامل:

موتور قیمت‌گذاری هوشمند با ۴ زون و ۳ نوع سرویس
ثبت سفارش آنلاین چند بسته‌ای با محاسبه لحظه‌ای قیمت
تولید خودکار اسناد (AWB, Invoice, Label) با بارکد استاندارد
پورتال مشتری کامل با کیف پول، پرداخت آنلاین و اعلان‌ها
پنل مدیریت قدرتمند با Filament 3.3
سیستم ترکینگ با قابلیت مهاجرت داده‌های تاریخی

🏗️ معماری سیستم

این پروژه بر اساس الگوی Headless طراحی شده است — فرانت‌اند (WordPress) و بک‌اند (Laravel) کاملاً جدا و فقط از طریق REST API با هم ارتباط دارند.

┌──────────────────────────────────────────────────────┐
│                  CLIENT BROWSER                  │
└────────────────────────┬─────────────────────────────┘
                         │
┌────────────────────────▼─────────────────────────────┐
│              WORDPRESS (Frontend)                   │
│  ┌───────────────────┐  ┌──────────────────────────┐  │
│  │   IFNEX Theme     │  │   IFNEX Bridge Plugin   │  │
│  │   (Landing Page)  │  │   (REST Client)         │  │
│  └───────────────────┘  └────────────┬─────────────┘  │
└───────────────────────────────────┼───────────────────┘
                                    │ REST API (Sanctum)
┌───────────────────────────────────▼───────────────────┐
│              LARAVEL 11 (Backend)                    │
│  ┌─────────────────┐  ┌──────────────┐  ┌────────────┐  │
│  │   Filament      │  │   API         │  │  Services   │  │
│  │   Admin Panel   │  │   Controllers │  │  (Pricing, │  │
│  │                  │  │              │  │   PDF,     │  │
│  └─────────────────┘  └──────┬───────┘  │   Payment) │  │
└──────────────────────────┼────┼─────────┘────────────┘  │
                           │    │                            │
                  ┌──────▼────▼────┐                     │
                  │  MySQL 8      │                     │
                  │  Database     │                     │
                  └───────────────┘                     │

📁 ساختار پروژه

IFNEX-Logistics/
├── 📄 01_Documents/          # مستندات فنی پروژه
│   ├── IFNEX_File_Map.md     # نقشه کامل فایل‌ها
│   ├── IFNEX_Roadmap.md      # نقشه راه پروژه
│   ├── IFNEX_Phase0_Checklist.md
│   ├── IFNEX_DEPRECATED_FILES_NOTICE.md
│   └── EXCEL_ANALYSIS.md     # تحلیل داده‌های تاریخی
│
├── 🌐 03_WordPress/          # فرانت‌اند (WordPress)
│   └── wp-content/
│       ├── themes/ifnex/     # قالب سفارشی IFNEX
│       └── plugins/
│           └── ifnex-bridge/ # پلاگین ارتباط با لاراول
│
├── ⚙️ 04_Laravel/            # بک‌اند (Laravel 11)
│   ├── app/
│   │   ├── Filament/         # پنل مدیریت
│   │   ├── Http/Controllers/ # کنترلرها (API, Web)
│   │   ├── Models/           # مدل‌های Eloquent
│   │   ├── Services/         # لایه سرویس
│   │   └── Imports/          # Excel imports
│   ├── database/migrations/  # ۱۵+ migration
│   ├── resources/views/
│   │   ├── pdfs/             # قالب‌های PDF
│   │   └── filament/         # Blade views
│   └── routes/
│       ├── api.php           # REST API endpoints
│       └── web.php           # Public routes
│
├── 📋 README.md              # این فایل
├── 📋 DEPLOYMENT.md          # راهنمای استقرار
└── 📋 04_Laravel/README.md   # راهنمای بک‌اند

✨ ویژگی‌های کلیدی

فاز ۰ — بنیان سیستم ✅

اسکیمای دیتابیس مدرن با ۴ زون مجزا (Export/Import × Parcel/Doc)
مهاجرت ۳۹۵۰ رکورد تاریخی از اکسل به دیتابیس
پنل مدیریت Filament با UX تخصصی اپراتور
API ترکینگ با امنیت API Key + Rate Limiting
پلاگین WordPress Bridge برای ارتباط با فرانت‌اند

فاز ۱ — پورتال مشتری ✅

احراز هویت Laravel Sanctum + Bridge Auth
فرم ثبت سفارش چندمرحله‌ای با Wizard
داشبورد جامع مشتری (سفارشات، کیف پول، تراکنش‌ها، اعلان‌ها، رهگیری، پروفایل)
سیستم ترکینگ با تایم‌لاین

فاز ۲ — مالی و کیف پول ✅

سیستم کیف پول کامل با تراکنش‌ها
درگاه پرداخت + Mock Gateway برای تست
مدیریت ارزهای چندگانه (IRR, AED, USD, EUR)
کدهای تخفیف با اعتبارسنجی و محدودیت مصرف
تولید PDF حرفه‌ای (AWB, Invoice, Label) با بارکد

فاز ۳ — بهبود و یکپارچه‌سازی 🔄

ایمپورت/اکسپورت نرخ‌ها با دانلود Template
سیستم اعلان‌های دیتابیس (ادمین + مشتری)
پشتیبانی از چند بسته در یک سفارش (Multi-Package)
تاریخچه تغییرات وضعیت
استایل مدرن تراکنش‌ها و هشدار آدرس انگلیسی

⚡ شروع سریع

پیش‌نیازها

PHP 8.2+
Composer 2.x
MySQL 8+
WordPress 7.0+

نصب

# ۱. کلون مخزن
git clone https://www.git.vernahost.ir/gitmodir110/ifnex.git
cd ifnex/04_Laravel

# ۲. نصب وابستگی‌ها
composer install

# ۳. تنظیم فایل محیط
cp .env.example .env
php artisan key:generate

# ۴. ایجاد دیتابیس
mysql -u root -p -e "CREATE DATABASE ifnex_db CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;"
# ۵. ویرایش .env و تنظیم DB_DATABASE, DB_USERNAME, DB_PASSWORD
# ۶. اجرای migrations و seeders
php artisan migrate --force
php artisan db:seed --force
# ۷. اجرای سرور
php artisan serve

📖 برای راهنمای کامل استقرار، DEPLOYMENT.md را ببینید.

🛠️ Stack فنی

Backend (Laravel)

تکنولوژی	نسخه	کاربرد
Laravel	11.x	فریمورک اصلی
PHP	8.2+	زبان برنامه‌نویسی
Filament	3.3.x	پنل مدیریت ادمین
MySQL	8+	دیتابیس
Dompdf	Latest	تولید PDF
Laravel Excel	Latest	Import/Export
Sanctum	Latest	API Authentication
Morilog Jalali	3.x	تاریخ شمسی

Frontend (WordPress)

تکنولوژی	نسخه	کاربرد
WordPress	7.0.3	CMS
IFNEX Theme	Custom	قالب سفارشی
IFNEX Bridge	1.6.0	پلاگین ارتباطی

📚 مستندات

برای مطالعه دقیق منطق‌های سیستم:

فایل	محتوا	اولویت
IFNEX_Phase0_Checklist.md	چک‌لیست کامل فازها	⭐⭐⭐
IFNEX_Roadmap.md	نقشه راه آینده	⭐⭐⭐
IFNEX_File_Map.md	نقشه ۱۰۰+ فایل پروژه	⭐⭐⭐
DEPLOYMENT.md	راهنمای استقرار Production	⭐⭐
EXCEL_ANALYSIS.md	تحلیل داده‌های اکسل	⭐⭐

🚀 مراحل بعدی

اتصال به API های ترکینگ زنده (TrackingMore/17track)
پلاگین SMS برای اطلاع‌رسانی
مستندات API (OpenAPI/Swagger)
راهنمای اپراتور (Operator Manual)
تست‌های واحد و Integration

📞 تماس

توسعه‌دهنده: Kazem Alghasi
شرکت: VernaSoft Group
ایمیل: kazem@vernasoft.group
مخزن: git.vernahost.ir/gitmodir110/ifnex

📜 لایسنس

11 KiB Raw Blame History Unescape Escape