Hamza/intaleq
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
main
intaleq/docs/01_overview/PROJECT_OVERVIEW.md
T
Hamza-AyedandClaude Opus 5 0aab85c732 refactor: إعادة تسمية التطبيقات الأربعة siro_* → intaleq_* 
المجلدات وأسماء حزم dart واستيراداتها:
  siro_rider → intaleq_rider    siro_driver  → intaleq_driver
  siro_admin → intaleq_admin    siro_service → intaleq_service

شمل ذلك `name:` في كل pubspec وكل `package:siro_*` في الاستيرادات
(115 ملفاً في rider وحده)، وإشارات أسماء المجلدات في docs/ وتعليق في
backend/Admin/notifications/broadcast.php. لم تبقَ إشارة واحدة (تحقّقت).

+ ضُمّت حزم get و get_storage داخل intaleq_driver/packages/ وحُوّلت
مساراتها الثلاثة من `../../Intaleq/packages/*` إلى `./packages/*`. كانت
تُحل عرضاً إلى مجلد App/Intaleq القديم المجاور — تبعية خارج المستودع
تنكسر بأول نقل. لم يبقَ في أي تطبيق تبعية مسار خارج الشجرة.

⚠️ لم تُمسّ بعد: هويات المتاجر (applicationId · PRODUCT_BUNDLE_IDENTIFIER ·
shorebird app_id) ولا الألوان ولا النصوص المرئية ولا النطاقات — كل منها
كوميت منفصل، والهويات تحتاج قرار المالك.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
2026-07-27 16:10:58 +03:00

135 lines
9.0 KiB
Markdown
Raw Permalink Blame History

# PROJECT_OVERVIEW — Siro (Siro) Ride-Hailing Platform
## Business Purpose
Siro (Siro) is a multi-region ride-hailing platform connecting passengers with drivers (captains). It operates across Syria, Jordan, and Egypt. The platform supports multiple car types (Speed, Comfort, Family, Delivery, Electric, Van, Bike) with dynamic pricing via a "Kazan" percentage-based commission system.
### Core Ride-Hailing Workflow
1. Passenger requests ride → System searches nearby drivers → Driver accepts → Navigate to pickup → Ride begins → Ride completes → Payment processed → Rating submitted
### User Types
- **Passenger** (Rider) — Requests rides via intaleq_rider app
- **Driver** (Captain) — Accepts rides via intaleq_driver app
- **Admin** — Manages system via intaleq_admin app (Flutter Web/PWA)
- **Service Agent** — Manages driver registration via intaleq_service app
- **Employee** — Staff managing drivers, passengers, complaints
### Driver Types
| Type | Code | Description |
|------|------|-------------|
| Speed | Speed | Standard rides |
| Comfort | Comfort | Premium rides |
| Family | Family | Larger vehicle |
| Delivery | Delivery | Package delivery |
| Free/Blash | Blash | Economy |
| Late | Late | Off-peak |
| Heavy | Heavy | Cargo |
| Nature | Nature | Scenic routes |
| Electric | Electric | EV |
| Pink Bike | PinkBike | Motorcycle |
| Van | Van | Minibus |
| Female Driver | FemalDriver | Women-only |
### Payment Methods
- Cash
- Visa/Credit Card (PayMob)
- Wallet (internal balance)
- MTN Mobile Money
- Syriatel Mobile Money
- E-Cash
- Stripe
### External Integrations
| Service | Purpose |
|---------|---------|
| Google Maps | Map rendering, geocoding, routing |
| Here Maps | Place autocomplete |
| Map SaaS (intaleqapp.com) | Custom routing, reverse geocoding, places |
| OpenStreetMap (routec/routesy) | OSRM routing |
| Firebase | Push notifications, analytics, crashlytics |
| PayMob | Payment gateway |
| Twilio | SMS verification |
| WhatsApp Cloud API | OTP delivery |
| Azure OCR | Document scanning |
| OpenAI GPT | Document data extraction |
| Llama AI | Document data extraction |
| Agora | Voice/video calls |
| WebRTC | Signaling service |
| SMS Kazumi | SMS provider (Egypt) |
---
## System Modules
| Module | Purpose | Dependencies | Main Files |
|--------|---------|--------------|------------|
| **Authentication** | Login, signup, OTP, JWT management, Google/Apple auth | Firebase, Twilio, WhatsApp | `intaleq_rider/lib/controller/auth/*.dart`, `backend/auth/*.php` |
| **Dispatching** | Ride request → driver matching → offer → accept | WebSocket, MySQL GIS | `socket_intaleq/*.php`, `backend/ride/*.php` |
| **Matching** | Nearby driver search via spatial queries | MySQL SPATIAL indexes | `backend/ride/location/*.php` |
| **Maps & GIS** | Map rendering, routing, geocoding, driver tracking | Google Maps, Map SaaS, OSRM | `intaleq_rider/lib/controller/home/map/*.dart` |
| **Payments** | Ride payment, wallet, PayMob, MTN, Syriatel, E-Cash | PayMob, Stripe | `intaleq_rider/lib/controller/payment/*.dart`, `backend/ride/payment/*.php` |
| **Wallet** | Passenger & driver balance management | Payment server (walletintaleq.xyz) | `intaleq_rider/lib/controller/payment/passenger_wallet_history_controller.dart` |
| **Notifications** | Push (FCM), local, in-app notifications | Firebase | `intaleq_rider/lib/controller/firebase/*.dart` |
| **Chat** | In-app messaging between driver & passenger | PHP API | `backend/ride/chat/send_message.php` |
| **Rating** | Post-ride driver & passenger ratings | MySQL | `intaleq_rider/lib/controller/rate/*.dart`, `backend/ride/rate/*.php` |
| **Promotions** | Promo codes, referral rewards | MySQL | `intaleq_rider/lib/controller/home/profile/promos_controller.dart` |
| **AI Services** | OCR document scanning, data extraction | Azure OCR, OpenAI, Llama | `intaleq_rider/lib/controller/functions/crud.dart` (getLlama, getChatGPT, arabicTextExtractByVisionAndAI) |
| **Admin Functions** | Dashboard, driver/passenger management, analytics | All backend APIs | `intaleq_admin/lib/controller/admin/*.dart` |
| **Realtime Tracking** | WebSocket driver location streaming, passenger tracking | Socket.IO (PHP) | `socket_intaleq/*.php`, `intaleq_rider/lib/controller/home/map/map_socket_controller.dart` |
| **Referral System** | Unified referral codes for drivers & passengers | MySQL | `backend/migration_referral_system.sql`, `backend/ride/invitor/*.php` |
| **Complaints** | Post-ride issue resolution | MySQL | `intaleq_rider/lib/controller/home/profile/complaint_controller.dart`, `backend/Admin/AdminRide/` |
| **Emergency** | SOS signals, safety features | Agora, WebRTC | `intaleq_rider/lib/services/emergency_signal_service.dart` |
## Architecture Overview
```
┌─────────────────────────────────────────────────────┐
│ Mobile Apps (Flutter) │
│ ┌─────────────┐ ┌──────────────┐ ┌────────────┐ │
│ │ intaleq_rider │ │ intaleq_driver │ │ intaleq_admin │ │
│ │ (Passenger) │ │ (Captain) │ │ (Admin) │ │
│ └──────┬──────┘ └──────┬───────┘ └─────┬──────┘ │
└─────────┼─────────────────┼─────────────────┼────────┘
│ │ │
▼ ▼ ▼
┌─────────────────────────────────────────────────────┐
│ API Gateway (api.intaleq.xyz) │
│ ┌───────────┐ ┌──────────┐ ┌───────────────────┐ │
│ │ Auth API │ │ Ride API │ │ Payment API │ │
│ └───────────┘ └──────────┘ └───────────────────┘ │
└──────────────────────┬──────────────────────────────┘
│
┌──────────────────────┴──────────────────────────────┐
│ Backend Servers (PHP) │
│ ┌──────────┐ ┌──────────┐ ┌───────────────────┐ │
│ │ Main API │ │ Ride API │ │ Payment Server │ │
│ │ siro_v3│ │ rides. │ │ walletintaleq.xyz│ │
│ └──────────┘ └──────────┘ └───────────────────┘ │
│ ┌──────────┐ ┌──────────┐ ┌───────────────────┐ │
│ │ Location │ │ Socket │ │ Map SaaS │ │
│ │ location.│ │ rides. │ │ map-saas. │ │
│ └──────────┘ └──────────┘ └───────────────────┘ │
└──────────────────────┬──────────────────────────────┘
│
┌──────────────────────┴──────────────────────────────┐
│ MySQL Databases │
│ ┌────────────────┐ ┌─────────────────────┐ │
│ │ intaleqDB1 │ │ intaleq-ridesDB │ │
│ │ (Primary Main) │ │ (Ride-specific) │ │
│ └────────────────┘ └─────────────────────┘ │
└─────────────────────────────────────────────────────┘
```
## Tech Stack
| Layer | Technology |
|-------|-----------|
| Mobile | Flutter (Dart) with GetX state management |
| Backend | PHP (native, no framework) |
| Database | MySQL 8.0 with GIS (SPATIAL indexes, POINT columns) |
| Realtime | PHP WebSockets (Socket.IO compatible) |
| Maps | Google Maps (primary), Siro Maps (custom), OSRM routing |
| Payments | PayMob, custom wallet server |
| Auth | JWT, Firebase Auth, Google Sign-In, Apple Sign-In |
| Storage | GetStorage (local), FlutterSecureStorage |
| Push | Firebase Cloud Messaging (FCM) |
Reference in New Issue View Git Blame Copy Permalink