🍳 Crookey - iOS Recipe and Food Analysis App

Crookey is a comprehensive iOS application that combines recipe management, food analysis, and meal planning using modern Swift and SwiftUI. The app features advanced food scanning capabilities, personalized recipe recommendations, and seamless integration with health tracking platforms.

✨ Features

🔍 Food Scanning & Analysis

• AI-powered food recognition using Vision framework
• Real-time nutritional analysis and freshness detection
• Ingredient identification with confidence scoring
• Camera integration with photo library support

📱 Recipe Management

• Extensive recipe discovery with advanced search
• Personalized recommendations based on dietary preferences
• Save favorite recipes with offline access
• Interactive cooking mode with step-by-step guidance
• Social sharing and community features

🥗 Health & Nutrition

• HealthKit integration for nutrition tracking
• Dietary restriction and allergy management
• Calorie and macro tracking
• Wellness insights and progress monitoring

🛒 Meal Planning

• Weekly meal planning with shopping list generation
• Inventory management and expiration tracking
• Smart grocery recommendations
• Budget tracking and cost analysis

🎨 Modern UI/UX

• Native SwiftUI interface with iOS design guidelines
• Dark mode support with adaptive theming
• Accessibility features (VoiceOver, Dynamic Type)
• Smooth animations and responsive design

🔒 Privacy-First Pantry (MVP)

100% On-Device, Zero-Liability Architecture

• Private Pantry Management: SQLite-based local inventory with FileProtection encryption
• On-Device AI Recipes: Apple Foundation Models (3B params) - zero API costs, 100% offline
• Smart Expiration Tracking: Perishability notifications based on FSIS FoodKeeper data
• No Data Collection: Zero tracking, zero analytics, zero cloud uploads
• Offline-First: All core features work in Airplane Mode
• Privacy Guarantee: "This recipe was generated 100% on your device. Your data never left your phone."

Strategic Differentiator: Privacy is not a limitation—it's the core moat. Inspired by Paprika's success with the "anti-data-selling" user segment.

🏗️ Architecture

Privacy-First MVP Stack

Crookey implements a "thick-client, thin-server" architecture where all user data and AI processing remain on-device:

Client (iOS App)

• SwiftUI: Declarative UI framework for all interfaces
• SQLite: Local-first database with FileProtectionType.complete encryption
• Foundation Models: Apple's 3B parameter on-device LLM (iOS 18.2+)
• Clean Architecture: Decoupled UI → Business Logic → Data layers
• Async/Await: Swift 6 concurrency with actor isolation

Core Services

• DatabaseService: SQLite initialization with integrity checks and fallback stores (Core/Storage/)
• PantryService: CRUD operations with validation and query helpers (Services/)
• RecipeService: On-device prompt builder + Foundation Models integration (Services/)

Privacy Architecture

• Zero-Liability: Company cannot access user data (E2EE CloudKit for future sync)
• No Network Calls: All pantry and recipe operations work offline
• Encrypted at Rest: iOS Data Protection with complete file protection
• Minimal Backend: Future database updates only (no user data collection)

Traditional Stack (Pre-MVP Features)

• Core Data: Legacy recipe management with CloudKit sync
• Vision Framework: ML-powered image analysis for food scanning
• HealthKit: Nutrition tracking integration

📱 Requirements

Minimum Requirements

• iOS 15.0+ (for base app functionality)
• Xcode 15.4+
• Swift 5.9+
• Apple Developer Account (for device testing)

Privacy-First Pantry MVP Requirements

• iOS 18.2+ (for Foundation Models on-device AI)
• macOS 15.2+ (for testing on Mac)
• Physical device recommended (for realistic AI performance testing)

🚀 Quick Start

1. Clone the Repository

git clone https://github.com/kakashi3lite/Crookey.git
cd Crookey

2. Setup Development Environment

./setup.sh

3. Open in Xcode

make open

4. Configure Team Settings

• Open project settings in Xcode
• Select your Apple Developer Team
• Update bundle identifier if needed

5. Build and Run

make dev  # Lint, build, and test
# Or press ⌘+R in Xcode

🛠️ Development Workflow

Available Commands

# Development
make dev           # Quick development workflow (lint, build, test)
make build         # Build the project
make test          # Run all tests
make clean         # Clean build artifacts

# Code Quality
make lint          # Run SwiftLint
make format        # Format code with SwiftFormat
make analyze       # Run static analysis

# Testing
make test-unit     # Run unit tests only
make test-ui       # Run UI tests only
make test-coverage # Generate coverage report

# Utilities
make open          # Open project in Xcode
make simulator     # Open iOS Simulator
make devices       # List available simulators

Git Hooks

Automatic quality checks are enabled:

• Pre-commit: SwiftLint validation
• Pre-push: Unit test execution

🧪 Testing

The project includes comprehensive testing:

Unit Tests (CrookeyTests/)

• Model validation and business logic
• Service layer testing
• Utility function verification

UI Tests (CrookeyUITests/)

• End-to-end user flows
• Multi-device compatibility
• Accessibility compliance

Test Plans

• UnitTests.xctestplan: Focused unit testing
• UITests.xctestplan: Cross-device UI testing
• AccessibilityTests.xctestplan: Accessibility validation

Run specific test suites:

xcodebuild test -scheme Crookey -testPlan UnitTests
xcodebuild test -scheme Crookey -testPlan UITests

🔄 CI/CD with Xcode Cloud

Crookey uses Xcode Cloud for automated CI/CD:

Workflows

• Development: Feature branch validation
• CI: Main branch testing and analysis
• Release: TestFlight deployment

Automated Checks

• ✅ SwiftLint code quality
• ✅ SwiftFormat style consistency
• ✅ Unit and UI test execution
• ✅ Multi-device compatibility
• ✅ Accessibility compliance
• ✅ Code coverage reporting

Deployment

git tag -a v1.0.0 -m "Release v1.0.0"
git push origin v1.0.0

Automatically builds and deploys to TestFlight.

📁 Project Structure

Crookey/
├── App/                          # App lifecycle and main entry point
│   ├── Models/                   # Data models and Core Data entities
│   ├── Services/                 # Business logic and API services
│   └── ViewModels/              # SwiftUI view models (MVVM)
├── Core/                        # Core functionality
│   ├── Config/                  # App configuration
│   ├── Network/                 # Networking layer
│   └── Storage/                 # Data persistence
├── Features/                    # Feature-based organization
│   ├── FoodScanner/            # Food scanning and analysis
│   ├── MealPlanning/           # Meal planning features
│   ├── Profile/                # User profile and settings
│   ├── Recipe/                 # Recipe management
│   ├── Search/                 # Recipe search functionality
│   └── Social/                 # Social features and sharing
├── UI/                         # User interface components
│   ├── Components/             # Reusable UI components
│   ├── Theme/                  # App theming and styling
│   └── Views/                  # Screen-level views
├── Services/                   # App-wide services
├── Tests/                      # Unit and UI tests
└── Resources/                  # Assets, localizations, etc.

🎯 Code Quality

SwiftLint Configuration

• 50+ enabled rules for consistent code style
• Custom rules for SwiftUI best practices
• Enforced file headers and documentation

SwiftFormat Configuration

• Automatic code formatting
• Consistent indentation and spacing
• Import organization and cleanup

Coverage Goals

• Unit Tests: >80% code coverage
• Critical Paths: 100% coverage
• UI Tests: Core user flows

🔐 Security & Privacy

Privacy-First Guarantees (MVP)

Zero-Liability Architecture

• No User Data Stored on Servers: All pantry data stays in local SQLite database
• No API Keys Required: Foundation Models runs 100% on-device (zero cloud AI calls)
• No Tracking SDKs: Zero analytics, zero telemetry, zero third-party data sharing
• Encrypted at Rest: Database protected via FileProtectionType.complete
• Offline-First: Core features work in Airplane Mode

Privacy Verification Process

Before ANY release, complete the Privacy Verification Checklist:

# Run comprehensive test suite
xcodebuild test -scheme Crookey -destination 'platform=iOS Simulator,name=iPhone 16 Pro'

# Verify privacy tests pass
# - testNoNetworkCallsDuringPantryOperations()
# - testDatabaseFileProtection()
# - Recipe generation in Airplane Mode

# Static analysis
swiftlint lint --strict
xcodebuild analyze -scheme Crookey

Key Privacy Tests:

1. ✅ Add pantry items in Airplane Mode
2. ✅ Generate recipes in Airplane Mode
3. ✅ Verify database file has FileProtectionType.complete
4. ✅ Confirm no URLSession/network code in PantryService or RecipeService
5. ✅ Check privacy message displayed on generated recipes

See Docs/PrivacyVerification.md for complete QA playbook.

Traditional Security (Pre-MVP Features)

• Local Processing: Food scanning via Vision framework on-device
• Secure API: HTTPS-only communications for recipe discovery
• Permission Management: Granular privacy controls for camera/photos
• CloudKit E2EE: Optional sync with Advanced Data Protection

🌍 Localization

Currently supporting:

• English (Base)
• Additional languages planned

🤝 Contributing

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

Contribution Guidelines

• Follow Swift style guidelines
• Include unit tests for new features
• Update documentation as needed
• Ensure accessibility compliance

📄 License

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

👥 Team

• Swanand Tanavade - Lead Developer

📞 Support

• Issues: GitHub Issues
• Documentation: Wiki
• Discussions: GitHub Discussions

🚀 Roadmap

Version 1.0

• Core recipe management
• Food scanning functionality
• Basic meal planning
• Health integration
• Xcode Cloud CI/CD

Version 1.1 (Planned)

• Advanced meal planning
• Social features expansion
• Offline recipe storage
• Apple Watch companion app

Version 2.0 (Future)

• AR food scanning
• Voice recipe instructions
• Smart kitchen integration
• Multi-language support

---

Made with ❤️ for iOS developers and food enthusiasts.