Order is a comprehensive, multi-platform e-commerce and delivery management ecosystem. Built with modern, scalable technologies, this platform bridges the gap between customers, regional vendors, and logistics administrators, ensuring a seamless, real-time order fulfillment pipeline.

Our platform consists of three tightly integrated repositories:

• Dynamic Catalog: Browse through vendor items with smooth image caching and dynamic UI states.
• Intelligent Cart System: Cart validation strictly checks for regional coverage and real-time vendor availability before checkout.
• Order Tracking: End-to-end real-time visibility from pending to delivered status.
• Push Notifications: Instant alerts via Firebase Cloud Messaging for critical order updates.
• Favorites & Profile Management: Persistent user preferences and secure tokenized sessions.

• Order Pipeline Control: Strict state machine enforcement (Admin Confirm → Vendor Accept).
• Vendor Status Overrides: Automated business hours toggling with manual status override capabilities.
• Inventory Management: Full CRUD operations for regional catalogs, including robust image handling.
• Regional Routing: Intelligent order routing based on branch coverage and delivery zones.
• Operational Analytics: Integrated visual dashboards and charts utilizing fl_chart.

• Domain-Driven API: Deeply compartmentalized PHP backend isolating user, vendor, and admin scopes.
• JWT Authentication: Secure, stateless token-based sessions across all clients.
• Strict Role-Based Access Control (RBAC): Ensuring complete data isolation across varying permission tiers.
• State Management: Reactive and localized UI updates powered by GetX.

┌─────────────────────────────────────────────────────────────┐
│                      Order Ecosystem                        │
├─────────────────────────────────────────────────────────────┤
│                                                             │
│  ┌─────────────┐                           ┌─────────────┐  │
│  │   Customer  │                           │ Admin/Vendor│  │
│  │  Mobile App │      [ FCM Push ]         │ Mobile App  │  │
│  │  (Flutter)  │ <-----------------------> │  (Flutter)  │  │
│  └──────┬──────┘                           └──────┬──────┘  │
│         │                                         │         │
│         │                                         │         │
│         └────────────────────┬────────────────────┘         │
│                              │                              │
│                     ┌────────▼────────┐                     │
│                     │   Backend API   │                     │
│                     │   (PHP/MySQL)   │                     │
│                     │                 │                     │
│                     │  - JWT Auth     │                     │
│                     │  - Routing Logic│                     │
│                     │  - RESTful      │                     │
│                     │  - File Upload  │                     │
│                     └────────┬────────┘                     │
│                              │                              │
│                     ┌────────▼────────┐                     │
│                     │  MySQL Database │                     │
│                     │                 │                     │
│                     │  - Catalogs     │                     │
│                     │  - Orders       │                     │
│                     │  - Users/Roles  │                     │
│                     │  - Regional Data│                     │
│                     └─────────────────┘                     │
│                                                             │
└─────────────────────────────────────────────────────────────┘

• Framework: Flutter 3.6+
• State Management: GetX
• Storage: GetStorage, Flutter Secure Storage
• Networking: HTTP package with interceptors
• Push Notifications: Firebase Cloud Messaging (FCM)
• UI Components: Material Design + Custom Animated Widgets

• Language: PHP 8.0+
• Database: MySQL 8.0+
• Architecture: Domain-Driven RESTful Design
• Authentication: JWT Tokens
• Media: Native PHP file validation and localized secure storage

• For Mobile Apps:

  • Flutter SDK (>=3.6.0)
  • Dart SDK
  • Android Studio / VS Code
  • Valid Firebase configuration files (google-services.json / GoogleService-Info.plist)

• For Backend:

  • PHP (>=8.0)
  • MySQL (>=8.0)
  • Apache/Nginx Web Server

# Clone the individual repositories
git clone https://github.com/your-org/backend.git
git clone https://github.com/your-org/order_app.git
git clone https://github.com/your-org/order_admin.git

cd backend

# Configure database credentials in config directories
# Import the provided SQL schema
mysql -u username -p database_name < sql/schema.sql

# Set correct read/write permissions for media uploads
chmod -R 755 upload/

# Serve the backend
php -S localhost:8000

cd order_app  # or cd order_admin

# Install dependencies
flutter pub get

# Ensure Firebase configs are placed in their respective platform folders
# Run the application
flutter run

https://api.your-domain.com/

All protected endpoints require a JWT token:

Authorization: Bearer {your_jwt_token}

Success:

{
  "status": "success",
  "data": { ... }
}

Error:

{
  "status": "failure",
  "message": "Error description"
}

• Authentication: Stateless JWT implementation preventing session hijacking.
• Client Security: Code obfuscation and root detection enabled for production mobile builds.
• SQL Injection Prevention: Parameterized queries across all database interactions.
• Data Isolation: Strict RBAC rules preventing cross-tenant data leakage.

• Always serve API endpoints over HTTPS in production environments.
• Keep Firebase keys securely excluded from public version control.

We welcome contributions from the community. Please read our Contributing Guidelines before submitting pull requests.

• Adhere to the Flutter Style Guide and Dart best practices.
• Document complex UI state transitions inside GetX controllers.
• Ensure API changes do not break legacy mobile client versions.

This project is licensed under the MIT License - see the LICENSE file for details.