Rifqi | رفيقي

Your smart guide to happy pets | دليلك الذكي لرفيقك الأليف

A GCC-focused intelligent pet identification and care application built with Flutter.

---

🎯 Mission

Rifqi empowers GCC pet owners with:

1. AI-powered pet & breed identification from photos
2. Intelligent care recommendations (feeding, health, training)
3. Local ecosystem integration (pet shops, vets, groomers)
4. Social media-ready pet photos with branding
5. Free + Pro subscription model for sustainability

---

✨ Key Features

🔍 Pet Identification

• Upload or take a photo of any pet
• AI identifies species and breed
• Detailed breed profiles (temperament, size, health, care needs)
• GCC climate suitability notes

💚 Intelligent Care

• Personalized feeding plans
• Exercise recommendations
• Grooming schedules
• Vet checkup reminders
• GCC-specific advice (heat safety, indoor living)

🏥 Local Directory

• Pet shops (food, toys, accessories)
• Veterinary clinics (general, emergency, exotic)
• Groomers and pet sitters (future)
• Filter by city, services, opening hours

📸 Social Sharing

• Enhanced pet camera with aspect ratios
• Branded photo templates and watermarks
• Auto-generated bilingual captions
• One-tap share to Instagram, WhatsApp, etc.

📚 Education Hub

• Curated articles on pet care
• Topics: feeding, training, health, grooming, behavior
• GCC-focused content (heat management, indoor tips)

💎 Rifqi Pro

• Unlimited pet identifications
• Unlimited pets in "My Pets"
• Extended breed profiles
• Advanced care planning
• Premium photo templates
• All education content

---

🏗️ Architecture

Tech Stack

• Framework: Flutter 3.0+ (Dart)
• State Management: Riverpod
• Routing: GoRouter
• Local Storage: Hive
• Localization: flutter_localizations + intl
• Fonts: Google Fonts (Poppins, Cairo)

Design Pattern

Clean Architecture with Feature-First organization:

lib/
├── core/          # Theme, routing, localization, constants
├── domain/        # Entities, use cases
├── data/          # Services, repositories, models
├── features/      # Feature modules (UI + logic)
└── widgets/       # Shared components

Key Design Decisions

• ✅ Bilingual-first: Complete EN/AR support with RTL
• ✅ GCC-focused: Climate notes, regional content
• ✅ Offline-capable: Hive for local-first experience
• ✅ Backend-ready: Mock services easily swappable
• ✅ Material 3: Modern, accessible design system

---

🚀 Getting Started

Prerequisites

• Flutter SDK 3.0+
• Dart SDK 3.0+
• Android Studio / Xcode
• iOS device/simulator (for iOS testing)
• Android device/emulator (for Android testing)

Installation

1. Clone the repository

   git clone https://github.com/your-org/rifqi-pets-app.git
   cd rifqi-pets-app

2. Install dependencies

   flutter pub get

3. Generate code (Hive adapters)

   flutter pub run build_runner build --delete-conflicting-outputs

4. Run the app

   flutter run

Project Setup Checklist

• Add fonts to assets/fonts/ (Poppins, Cairo) or use google_fonts (already configured)
• Add logo image to assets/logo/rifqi_logo.png
• Add onboarding images to assets/onboarding/
• Configure native splash: flutter pub run flutter_native_splash:create
• Configure app icons: flutter pub run flutter_launcher_icons

---

📁 Project Structure

rifqi_pets_app/
│
├── assets/
│   ├── logo/              # App logo and icons
│   ├── onboarding/        # Onboarding illustrations
│   ├── images/            # General images
│   ├── icons/             # Custom icons
│   ├── breeds/            # Breed photos (optional)
│   └── fonts/             # Poppins & Cairo fonts (optional with google_fonts)
│
├── lib/
│   ├── main.dart                  # App entry point
│   │
│   ├── core/
│   │   ├── theme/                 # ✅ Theme system (colors, typography)
│   │   ├── routing/               # TODO: GoRouter configuration
│   │   ├── localization/          # ✅ i18n setup
│   │   └── constants/             # ✅ App constants
│   │
│   ├── domain/
│   │   └── entities/              # ✅ All data models (User, Pet, Breed, etc.)
│   │
│   ├── data/
│   │   ├── services/              # ✅ Mock AI services
│   │   ├── mock_data/             # ✅ Mock breed database
│   │   ├── repositories/          # TODO: Hive repositories
│   │   └── local/                 # TODO: Hive initialization
│   │
│   ├── features/                  # TODO: UI screens by feature
│   │   ├── onboarding/
│   │   ├── home/
│   │   ├── pet_identification/
│   │   ├── pet_profile/
│   │   ├── my_pets/
│   │   ├── care_plan/
│   │   ├── reminders/
│   │   ├── education/
│   │   ├── shops/
│   │   ├── vets/
│   │   ├── camera_share/
│   │   ├── subscription/
│   │   └── settings/
│   │
│   ├── widgets/                   # TODO: Shared UI components
│   │
│   └── l10n/
│       ├── intl_en.arb            # ✅ English translations
│       └── intl_ar.arb            # ✅ Arabic translations
│
├── RIFQI_ARCHITECTURE.md          # ✅ Detailed architecture docs
├── IMPLEMENTATION_STATUS.md       # ✅ What's done, what's next
├── pubspec.yaml                   # ✅ Dependencies configured
└── README.md                      # ✅ This file

Legend:

• ✅ = Completed
• TODO = Needs implementation

---

🎨 Brand Identity

Colors

• Primary Teal: #00897B - Calm, modern, trustworthy
• Warm Coral: #FF7043 - Playful accent for CTAs
• Soft Cream: #FFF3E0 - Background warmth
• Paw Grey: #CFD8DC - Neutral elements

Typography

• English: Poppins (friendly, rounded, modern)
• Arabic: Cairo (clean, highly readable)

Tone

• Warm, friendly, trustworthy
• Family-oriented, caring
• Intelligent without being clinical
• GCC culturally aware

---

🌍 Localization

Supported Languages

• 🇬🇧 English (LTR)
• 🇸🇦 Arabic (RTL)

Adding Translations

1. Edit lib/l10n/intl_en.arb and intl_ar.arb
2. Run code generation (if using flutter_gen):

   flutter pub run intl_utils:generate

GCC Countries

• 🇰🇼 Kuwait
• 🇸🇦 Saudi Arabia
• 🇦🇪 United Arab Emirates
• 🇶🇦 Qatar
• 🇧🇭 Bahrain
• 🇴🇲 Oman

---

📊 Data Models

All entities are bilingual and Hive-ready:

• User - Authentication, subscription, preferences
• PetBreed - Complete breed encyclopedia
• UserPet - User's pets with care history
• PetPrediction - AI identification results
• PetCareAdvice - Personalized recommendations
• Reminder - Care reminders
• Article - Education content
• PetShop - Pet shop directory
• VetClinic - Veterinary clinic directory
• Subscription - Free/Pro management
• ShareTemplate - Photo sharing templates

See lib/domain/entities/ for complete definitions.

---

🤖 AI Services (Mock)

Pet Identification

PetIdentificationService

• Simulates ML model predictions
• Returns top 3 breed matches with confidence
• Production: Integrate TensorFlow Lite, Cloud Vision API, or custom model

Care Advisor

PetCareAdvisorService

• Rule-based care recommendations
• Considers breed, age, weight, GCC climate
• Production: Integrate LLM (GPT-4, Claude) for personalized advice

Breed Database

MockBreedsDatabase

• 10+ GCC-suitable breeds (dogs, cats, birds, rabbits)
• Bilingual content with climate notes
• Production: Replace with REST API or Firestore

---

💰 Monetization

Free Tier

• 20 pet identifications/month
• Up to 3 pets in "My Pets"
• Basic breed profiles
• Basic care tips
• Standard photo templates

Rifqi Pro (SaaS)

• Unlimited identifications
• Unlimited pets
• Extended breed profiles
• Advanced care planning
• Premium photo templates
• All education content
• Advanced reminders
• Customizable watermarks

Implementation: UI-only paywall for MVP. Backend billing integration ready.

---

🛣️ Roadmap

Phase 1: MVP ✅ (Current)

• ✅ Core architecture
• ✅ Theme & localization
• ✅ Data models
• ✅ Mock services
• 🚧 UI implementation (in progress)

Phase 2: AI Integration

• Real pet identification model (TensorFlow Lite / Cloud API)
• LLM-powered care chatbot
• Dynamic breed content from backend
• Personalized recommendations

Phase 3: Backend & Cloud

• User authentication (Firebase / Supabase)
• Cloud database & sync
• Push notifications
• Real subscription billing (In-App Purchases / Stripe)
• Analytics & crash reporting

Phase 4: Community & Commerce

• User reviews (shops/vets)
• Pet adoption listings
• E-commerce integration (affiliate links)
• Vet appointment booking
• Grooming service scheduling

Phase 5: Advanced Features

• Video pet identification
• Vet telemedicine
• Health tracker (weight, medications)
• Wearable integration (activity trackers)
• Multi-pet household optimization

---

📖 Documentation

• RIFQI_ARCHITECTURE.md - Technical deep dive
• IMPLEMENTATION_STATUS.md - Current status & next steps
• Code comments - Inline documentation throughout

---

🧪 Testing (Future)

# Unit tests
flutter test

# Integration tests
flutter test integration_test

# Widget tests
flutter test test/widgets

---

🤝 Contributing

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

---

📄 License

This project is proprietary. All rights reserved.

---

📞 Contact & Support

• Website: https://rifqi.app (future)
• Email: [email protected] (future)
• Social:
  • Instagram: @rifqi.app
  • X/Twitter: @RifqiApp
  • #RifqiApp #GCCPets

---

🙏 Acknowledgments

• Flutter team for amazing framework
• GCC pet community for inspiration
• All pet lovers across the Gulf

---

Built with ❤️ for pets and their families across the GCC