Rouh - Complete Documentation

🎯 Overview

Rouh is a premium Flutter application that provides personalized inspirational quotes based on user mood. It features AI-powered quote generation, multi-language support (Arabic, English, French, Spanish), and a beautiful glassmorphic UI design.

🤖 AI-Powered

Integrates with Gemini and DeepSeek APIs for intelligent quote generation

🌍 Multi-Language

Full RTL support for Arabic, plus English, French, and Spanish

💎 Premium UI

Modern glassmorphism design with smooth animations

📊 Analytics

Mood tracking and statistics with beautiful charts

✨ Features

Core Features

Mood-based quote selection (6 moods: Happy, Calm, Sad, Energetic, Neutral, Reflective)
AI-generated personalized quotes (Gemini & DeepSeek)
Favorites system with local storage
Quote sharing with customizable templates
Mood history and statistics with charts
Daily quote notifications
Custom quote creator
Dark/Light theme support

Monetization

Google AdMob (Banner, Interstitial, Native ads)
In-App Purchases (PRO subscription)
License key validation system

📦 Requirements

Development Environment

Requirement	Version	Notes
Flutter SDK	3.9.2+	Required
Dart SDK	Included	Comes with Flutter
Android Studio / VS Code	Latest	With Flutter extensions
Xcode	Latest	macOS only, for iOS

API Keys (Required)

📝 Note: You need at least one AI provider API key to use the quote generation feature.

Gemini API Key (Recommended) - Get it here
DeepSeek API Key (Alternative) - Get it here

🔑 API Configuration

1Get Your API Keys

Gemini API (Recommended)

Visit Google AI Studio
Sign in with your Google account
Click "Create API Key"
Copy the generated key

DeepSeek API (Alternative)

Visit DeepSeek Platform
Create an account
Navigate to API Keys section
Generate a new API key
Copy the key

2Configure the .env File

Open the .env file in the project root and edit:

                # AI Provider Configuration
GEMINI_API_KEY=your_gemini_api_key_here
DEEPSEEK_API_KEY=your_deepseek_api_key_here
AI_PROVIDER=gemini

# Options: gemini or deepseek
# gemini - Uses Google's Gemini AI (Recommended)
# deepseek - Uses DeepSeek AI (Alternative)
            

⚠️ Important:

Replace your_gemini_api_key_here with your actual Gemini API key
Set AI_PROVIDER to either gemini or deepseek
Keep this file secure - Never commit it to public repositories

3Install Dependencies & Run

                # Install dependencies
flutter pub get

# Run the app
flutter run
            

🎨 Customization Guide

1. Change App Name

Android

Edit android/app/src/main/AndroidManifest.xml:

                <application
    android:label="Your App Name"
    ...>
            

iOS

Edit ios/Runner/Info.plist:

                <key>CFBundleDisplayName</key>
<string>Your App Name</string>
            

2. Change App Logo/Icon

                # Install flutter_launcher_icons
flutter pub add --dev flutter_launcher_icons

# Place your icon in assets/icon/app_icon.png

# Generate icons
flutter pub run flutter_launcher_icons
            

3. Change Primary Colors

Edit lib/rh_app/core/constants/rh_app_colors.dart:

                class RhAppColors {
  // Main Brand Colors
  static const Color rouhTeal = Color(0xFF118AB2);      // Change this
  static const Color rouhMidnight = Color(0xFF073B4C);  // Change this
  static const Color rouhYellow = Color(0xFFFFD166);    // Change this
}
            

💡 Tip: Use Google Color Picker to find hex color codes.

4. Change Fonts

Edit lib/rh_app/core/theme/rh_app_theme.dart:

                // For Arabic text
GoogleFonts.marheyTextTheme(baseTextTheme)

// For English text
GoogleFonts.rowdiesTextTheme(baseTextTheme)
            

Replace with any font from Google Fonts.

📦 Building & Deployment

Change Package Name (Bundle ID)

Easy Method (Recommended)

                # Install package
flutter pub add --dev change_app_package_name

# Change package name
flutter pub run change_app_package_name:main com.yourcompany.yourapp
            

Build for Android

                # Debug APK
flutter build apk --debug

# Release APK
flutter build apk --release

# App Bundle (for Google Play)
flutter build appbundle --release
            

Output Location: build/app/outputs/

Build for iOS

                # Open in Xcode
open ios/Runner.xcworkspace

# Build from command line
flutter build ios --release
            

⚠️ iOS Requirements:

macOS with Xcode installed
Apple Developer Account ($99/year)
Configure signing in Xcode

Version Management

Update version in pubspec.yaml:

                version: 1.0.0+1
#        ↑     ↑
#     version  build number
            

🔧 Troubleshooting

Common Issues & Solutions

❌ "API Key Invalid" Error

Solution:

Verify your API key in .env file
Ensure no extra spaces or quotes
Check that the API key is active in the provider's dashboard

❌ Build Fails on Android

                    cd android
./gradlew clean
cd ..
flutter clean
flutter pub get
flutter build apk
                

❌ Build Fails on iOS

                    cd ios
pod deinstall
pod install
cd ..
flutter clean
flutter pub get
flutter build ios
                

❌ "Hive Box Not Found" Error

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

📜 Credits & Licenses

✅ Commercial Use Verified: All assets, libraries, fonts, and icons used in this application are free for commercial use.

Key Points

All dependencies licensed under permissive open-source licenses (MIT, Apache-2.0, BSD)
Google Fonts licensed under OFL (Open Font License) - fully commercial
Material Icons licensed under Apache 2.0
Full documentation in CREDITS.md

✅ Quick Setup Checklist

Install Flutter SDK 3.9.2+
Get Gemini API key from Google AI Studio
Configure .env file with API keys
Run flutter pub get
Test the app with flutter run
Customize colors in rh_app_colors.dart
Change app name in AndroidManifest.xml and Info.plist
Update package name with change_app_package_name
Build APK/IPA for deployment
Test all features thoroughly