Shifo (شيفو) - AI Culinary Assistant

Your Personal AI-Powered Chef & Nutritionist

Features • Screenshots • Demo • Tech Stack • Installation • Architecture • Contributing

---

About

Shifo (شيفو) is a Flutter application powered by Generative AI that acts as your personal culinary expert and nutritionist. Simply enter the ingredients you have available, and Shifo will suggest custom recipes complete with step-by-step cooking instructions, detailed nutrition information, and helpful add-ons.

Built with Flutter, Flask, and Firebase, it simplifies cooking, promotes healthy choices, and makes daily meals exciting!

---

Features

AI Recipe Generation Smart recipes based on your available ingredients	Nutrition Information Calories, protein, fats & carbs breakdown	Step-by-Step Instructions Easy-to-follow cooking guidance
Cloud Sync Save & access recipes across devices	Secure Authentication Firebase Auth with email & password	Arabic RTL Support Full Arabic interface with RTL layout

---

Screenshots

---

Demo

---

Tech Stack

Frontend

Technology	Purpose
	Cross-platform UI framework
	Programming language
	State management & routing

Backend & Services

Technology	Purpose
	Authentication & Firestore Database
	Backend API server
	Recipe generation engine

---

Architecture

┌─────────────────────────────────────────────────────────────┐
│                      Flutter App                             │
│  ┌─────────────┐  ┌─────────────┐  ┌─────────────────────┐  │
│  │   Screens   │  │ Controllers │  │      Services       │  │
│  │  (UI Layer) │◄─│   (GetX)    │◄─│  (Firebase/HTTP)    │  │
│  └─────────────┘  └─────────────┘  └─────────────────────┘  │
└──────────────────────────┬──────────────────────────────────┘
                           │
            ┌──────────────┴──────────────┐
            ▼                              ▼
┌───────────────────┐          ┌───────────────────────┐
│     Firebase      │          │     Flask Backend     │
│  ┌─────────────┐  │          │  ┌─────────────────┐  │
│  │    Auth     │  │          │  │  Recipe API     │  │
│  └─────────────┘  │          │  └─────────────────┘  │
│  ┌─────────────┐  │          │           │          │
│  │  Firestore  │  │          │           ▼          │
│  └─────────────┘  │          │  ┌─────────────────┐  │
└───────────────────┘          │  │  Generative AI  │  │
                               │  └─────────────────┘  │
                               └───────────────────────┘

---

Project Structure

lib/
├── main.dart                    # App entry point
├── routes.dart                  # App navigation routes
├── firebase_options.dart        # Firebase configuration
├── controllers/
│   └── auth_controller.dart     # Authentication logic
├── screens/
│   ├── welcome_screen.dart      # Onboarding pages
│   ├── login_screen.dart        # User login
│   ├── registration_screen.dart # User registration
│   ├── home_screen.dart         # Main ingredient selection
│   ├── recipe_ready_screen.dart # Recipe loading animation
│   ├── recipe_detail_screen.dart# Full recipe display
│   ├── recipe_steps_section.dart# Step-by-step instructions
│   ├── profile_screen.dart      # User profile management
│   ├── my_recipes_screen.dart   # Saved recipes list
│   └── saved_recipe_detail_screen.dart
└── theme/
    └── app_theme.dart           # App theming

---

Installation

Prerequisites

• Flutter SDK (3.0+)
• Dart SDK
• Android Studio / VS Code
• Firebase account

Setup Steps

1. Clone the repository

   git clone https://github.com/mh2des/Shifo_App.git
   cd Shifo_App

2. Install dependencies

   flutter pub get

3. Configure Firebase

   • Create a new Firebase project
   • Enable Authentication (Email/Password)
   • Set up Cloud Firestore
   • Download google-services.json (Android) and GoogleService-Info.plist (iOS)
   • Place them in the respective platform folders

4. Run the app

   flutter run

---

Configuration

Environment Variables

Create a .env file in the root directory:

API_BASE_URL=https://shifu-app-backend.onrender.com

Firebase Rules

rules_version = '2';
service cloud.firestore {
  match /databases/{database}/documents {
    match /users/{userId} {
      allow read, write: if request.auth != null && request.auth.uid == userId;
      
      match /saved_recipes/{recipeId} {
        allow read, write: if request.auth != null && request.auth.uid == userId;
      }
    }
  }
}

---

Supported Platforms

Platform	Status
Android	Fully Supported
iOS	Fully Supported
Web	Fully Supported
Windows	Experimental
macOS	Experimental
Linux	Experimental

---

Color Palette

Color	Hex	Usage
Primary Red	#E84730	Buttons, accents
Brown	#6C3428	Text, borders
Background	#F6F2E8	App background
White	#FFFFFF	Cards, inputs

---

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

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

---

Team

mh2des Developer

Faisal Khrisan Developer

---

License

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

---

Acknowledgments

• Flutter - UI framework
• Firebase - Backend services
• GetX - State management
• Icons8 - Icons used in this README

---

Made with love for food lovers everywhere