ifnex/04_Laravel/README.md
Kazem Alghasi f1eb6b179c docs(docs): update project documentation and roadmap
Update project documentation to reflect the transition to Laravel 11,
Filament 3.3, and the new 4-phase roadmap.

- Mark `PRD_v2.md` as deprecated and provide guidance on official
  sources (`Phase0_Proposal.docx`, `STATUS.md`).
- Update `Project_Roadmap.md` to reflect the current 4-phase structure
  and Phase 0 progress.
- Revise `04_Laravel/README.md` with detailed setup instructions,
  package lists, and directory structure.
- Update root `README.md` with versioning, technology stack details,
  and improved project structure overview.
2026-08-04 02:11:58 +03:30

120 lines
3.8 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# IFNEX Logistics — Backend (Laravel 11)
> بخش بک‌اند سیستم لجستیک ایف‌نکس. این پوشه به تنهایی یک اپلیکیشن لاراول ۱۱ کامل است.
---
## 🚀 راه‌اندازی سریع
```bash
composer install
cp .env.example .env
php artisan key:generate
php artisan migrate --force
php artisan db:seed --force
php artisan serve
```
---
## 📦 پکیج‌های اصلی
| پکیج | نسخه | نقش |
|------|------|-----|
| `laravel/framework` | ^11.0 | هسته فریم‌ورک |
| `filament/filament` | 3.3.* | پنل مدیریت ادمین |
| `maatwebsite/excel` | ^3.1 | ایمپورت اکسل |
| `morilog/jalali` | ^3.0 | تبدیل تاریخ شمسی/میلادی |
---
## 📁 ساختار کد
```
04_Laravel/
├── app/
│ ├── Models/ # مدل‌های Eloquent
│ ├── Enums/ # Enumهای سفارشی
│ ├── Services/ # منطق تجاری
│ ├── Http/
│ │ ├── Controllers/ # کنترلرها
│ │ ├── Middleware/ # میان‌افزارهای سفارشی
│ │ └── Requests/ # Form Request Validation
│ ├── Imports/ # کلاس‌های ایمپورت اکسل
│ ├── Console/Commands/ # دستورات Artisan سفارشی
│ └── Filament/ # پنل مدیریت
│ ├── Resources/ # منابع Filament
│ └── Pages/ # صفحات سفارشی
├── database/
│ ├── migrations/ # ۷ migration فاز ۰
│ └── seeders/ # seeders داده اولیه
├── routes/
│ ├── web.php # routes وب (Filament)
│ └── api.php # routes API
└── config/
├── ifnex.php # تنظیمات اختصاصی
└── cors.php # تنظیمات CORS
```
---
## 🔌 API Endpoints
| روش | مسیر | توضیحات |
|------|------|---------|
| GET | `/api/v1/track/{awb_no}` | استعلام وضعیت مرسوله با API Key |
**درخواست نمونه:**
```bash
curl -H "Authorization: Bearer ifnex-local-dev-key" http://localhost:8000/api/v1/track/TEST123
```
---
## 🛠️ دستورات Artisan سفارشی
```bash
# ایمپورت نرخ‌های حمل از اکسل
php artisan ifnex:import:rates {path}
# ایمپورت داده‌های تاریخی مرسوله‌ها
php artisan ifnex:import:shipments {path}
```
---
## 🔐 احراز هویت و دسترسی
| نقش | دسترسی |
|------|--------|
| `super_admin` | دسترسی کامل به همه بخش‌های Filament |
| `tracking_operator` | مدیریت ترکینگ و رویدادها |
| `data_entry` | وارد کردن داده‌های مرسوله |
| `customer` | دسترسی محدود (در فاز بعدی) |
---
## ⚠️ نکات مهم
- **Laravel 11** — با سوییچ از v12 انجام شد
- **Livewire 3.8.3** — فرم‌ها با AJAX کار می‌کنند، POST مستقیم به `/admin/login` ثبت نمی‌شود
- **Filament 3.3.x** — پنل مدیریت در مسیر `/admin`
- **MySQL 8+** — الزام migrations با JSON columns
---
## 📚 مستندات بیشتر
برای اطلاعات کامل‌تر به پوشه `01_Documents` در ریشه پروژه مراجعه کنید:
- `STATUS.md` — وضعیت فعلی و گزارش پیشرفت
- `IFNEX_Phase0_Checklist.md` — چک‌لیست دقیق فاز ۰
- `Phase0_Proposal.md` — مرجع اصلی پروژه
---
## 📜 لایسنس
© 2026 VernaSoft Group (Kazem Alghasi). All rights reserved.
این پروژه اختصاصی شرکت IFNEX است و کپی یا استفاده‌ی غیرمجاز از آن ممنوع است.