AI Chat Flutter Project

<<<<<<< HEAD A Flutter-based chat application with AI integration.

Getting Started: Your First Steps

======= A feature-rich Flutter-based chat application with AI integration, user-to-user messaging, and Firebase backend support. This app demonstrates modern Flutter development practices including Riverpod state management, clean architecture, and Firebase integration.

✨ Features

🤖 AI Chat - Chat with AI powered by OpenRouter LLM
👥 User-to-User Chat - Real-time messaging between users
🔐 Authentication - Google Sign-In and OTP-based authentication with Firebase
🔔 Push Notifications - Real-time notifications via Firebase Cloud Messaging
🌍 Multi-Language Support - English, Khmer, Japanese, and Spanish
🎨 Theme Support - Light and dark theme modes
📱 Responsive Design - Works seamlessly on Android and iOS
💾 Local Storage - Task management with local persistence using Hive

🛠 Tech Stack

Framework: Flutter 3.x
State Management: Riverpod
Backend: Firebase (Authentication, Firestore, Cloud Messaging)
API Client: Dio
Local Database: Hive
LLM Integration: OpenRouter API
Code Generation: Freezed, JsonSerializable

📋 Prerequisites

Before you begin, ensure you have:

Flutter SDK (3.0+) - Install Flutter
Dart SDK (included with Flutter)
Android Studio or Xcode (for emulator/device)
Firebase Account - Create at Firebase Console
Git - For cloning the repository

Verify Installation

flutter --version
dart --version

🚀 Getting Started: Your First Steps

7d9fef6f29f2a57f4f5db38905d5c8924ec4ab30

This guide will walk you through setting up and running the project. Follow these steps carefully, and you'll have the app running in no time!

1. Clone the Repository

First, get the project files onto your computer.

git clone <repository-url>
cd <repository-directory>

2. Clean Up & Get Dependencies

It's always a good idea to start with a clean slate and fetch all necessary packages.

flutter clean
flutter pub get

3. Set Up Firebase: The Backend Power

This project uses Firebase for authentication, database, and other services. You'll need to connect your app to your own Firebase project.

3.1. Create Your Firebase Project

Go to the Firebase console.
Click "Add project" and follow the on-screen instructions to create a new project.

3.2. Connect Your Android App to Firebase

This is crucial for features like Google Sign-In and push notifications.

Add an Android App: In your Firebase project, click the Android icon to add a new Android app.
- Package Name: Enter your app's package name. You can find this in android/app/build.gradle.kts (look for applicationId).
Get Your SHA-1 and SHA-256 Keys: These keys are essential for Google Sign-In and other Firebase services to verify your app's authenticity.
- For Windows: Open your terminal and run this command:
```
keytool -list -v -keystore "%USERPROFILE%\.android\debug.keystore" -alias androiddebugkey -storepass android -keypass android
```
- For macOS and Linux: Open your terminal and run this command:
```
keytool -list -v -keystore ~/.android/debug.keystore -alias androiddebugkey -storepass android -keypass android
```
- After running the command, copy both the SHA1 and SHA256 fingerprints from the output.
Add SHA Keys to Firebase: In your Firebase project settings, select your Android app, then click "Add fingerprint" and paste your copied SHA-1 and SHA256 keys.
Download google-services.json: Download the google-services.json file from the Firebase console.
Place google-services.json: Move this downloaded file into the android/app directory of your Flutter project.

3.3. Connect Your iOS App to Firebase (Optional, if targeting iOS)

Add an iOS App: In your Firebase project, click the iOS icon to add a new iOS app.
Download GoogleService-Info.plist: Download the GoogleService-Info.plist file from the Firebase console.
Place GoogleService-Info.plist: Move this file into the ios/Runner directory of your Flutter project.

3.4. Deploy Firestore Rules (If you modify them)

If you make changes to your Firestore security rules (firestore.rules), you'll need to deploy them.

firebase deploy --only firestore:rules --project <your-firebase-project-id>

Replace <your-firebase-project-id> with your actual Firebase project ID.

<<<<<<< HEAD

4. Add AI Provider API Key

The application uses Custom LLM via OpenRouter for its AI chat features. For detailed steps on how to obtain your API key, refer to How to Get Your OpenRouter AI API Key.

Create a file named .env in the root of the project.
Add your OpenRouter API key to the .env file as follows:
```
AI_API_KEY='your_api_key_here'
```

=======

4. Configure Environment Variables

This project requires several API keys and configuration values. These are stored in a .env file which is not included in the repository for security reasons.

4.1. Create Your `.env` File

Copy the example file to create your own:
```
cp .env.example .env
```

Edit the .env file and replace all placeholder values with your actual credentials:

# LLM Configuration (Required for AI features)
AI_API_KEY=your_actual_api_key_here
CUSTOM_LLM_ENDPOINT=https://your-custom-llm-endpoint.com/api/v1/chat/completions
CUSTOM_LLM_model=your_model_name
BASE_API_URL=https://your-backend-api-url.com

# Firebase Configuration (Required)
FIREBASE_PROJECT_ID=your_firebase_project_id
FIREBASE_API_KEY=your_firebase_api_key
FIREBASE_APP_ID=your_firebase_app_id
FIREBASE_MESSAGING_SENDER_ID=your_firebase_sender_id
FIREBASE_STORAGE_BUCKET=your_firebase_storage_bucket
FIREBASE_ANDROID_CLIENT_ID=your_android_client_id
FIREBASE_IOS_CLIENT_ID=your_ios_client_id
FIREBASE_IOS_BUNDLE_ID=your_ios_bundle_id

4.2. Get Your API Keys

AI_API_KEY & CUSTOM_LLM Settings: For OpenRouter LLM integration, see How to Get Your OpenRouter AI API Key
Firebase Configuration: Get these from your Firebase project settings
Backend API URL: Use your own backend API endpoint (or a development server URL)

7d9fef6f29f2a57f4f5db38905d5c8924ec4ab30

5. Generate Code (Build Runner)

This project uses code generation. You need to run the build runner to generate necessary files.

flutter run build_runner

6. Run the Application

Finally, launch the application!

flutter run

<<<<<<< HEAD

📁 Project Structure

lib/
├── app.dart                 # Main app configuration
├── main.dart                # Entry point
├── firebase_options.dart    # Firebase configuration
├── core/
│   ├── api/                 # API client setup (Dio)
│   ├── config/              # Environment configuration
│   ├── services/            # Services (Firebase, Sound, etc.)
│   ├── utils/               # Utility functions
│   ├── widgets/             # Reusable widgets
│   └── errors/              # Error handling
├── features/
│   ├── ai_chat/             # AI Chat feature
│   ├── utou_chat/           # User-to-User Chat feature
│   ├── auth/                # Authentication feature
│   ├── home/                # Home/Dashboard feature
│   ├── tasks/               # Task management feature
│   ├── app_settings/        # App settings & preferences
│   └── user/                # User profile feature
├── l10n/                    # Localization files
└── app/
    ├── router.dart          # Route configuration
    └── theme/               # Theme configuration

🔧 Troubleshooting

Build Issues

`MissingPluginException`

Problem: Plugin not initialized
Solution: Run flutter clean and flutter pub get

`Firebase Configuration Error`

Problem: google-services.json not found
Solution: Ensure google-services.json is placed in android/app/ directory

`Build Cache Issues`

Problem: Strange compilation errors
Solution: Clean everything:

flutter clean
rm -rf pubspec.lock
flutter pub get

Runtime Errors

`Invalid BASE_API_URL`

Problem: BaseUrl must be a valid URL
Solution: Check .env file has a valid BASE_API_URL value

`FocusNode Disposed Error`

Problem: FocusScopeNode already disposed
Solution: Update to the latest version of the app (we've fixed this)

Firebase Issues

No notifications? Ensure Firebase Cloud Messaging is enabled in your Firebase Console
Auth not working? Check SHA-1 and SHA-256 keys are correctly added to Firebase
Firestore errors? Verify firestore rules are deployed: firebase deploy --only firestore:rules

📚 Documentation

For more detailed information, check out our documentation:

🤝 Contributing

Contributions are welcome! To contribute:

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

Please ensure your code follows the Best Practices guide.

📝 License

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

📧 Support

For issues, feature requests, or questions:

Open an GitHub Issue
Check existing documentation

🙏 Acknowledgments

Flutter team for the amazing framework
Firebase for backend services
OpenRouter for LLM integration
All our contributors and supporters

Happy Coding! 🚀

7d9fef6f29f2a57f4f5db38905d5c8924ec4ab30

Name		Name	Last commit message	Last commit date
.github/workflows		.github/workflows
android		android
assets		assets
docs		docs
functions		functions
ios		ios
lib		lib
test		test
.env.example		.env.example
.firebaserc		.firebaserc
.fvmrc		.fvmrc
.gitignore		.gitignore
.metadata		.metadata
README.md		README.md
analysis_options.yaml		analysis_options.yaml
devtools_options.yaml		devtools_options.yaml
firebase.json		firebase.json
firestore.indexes.json		firestore.indexes.json
firestore.rules		firestore.rules
fvm_config.json		fvm_config.json
pubspec.lock		pubspec.lock
pubspec.yaml		pubspec.yaml

Uh oh!

Latest commit

History

Folders and files

Repository files navigation

AI Chat Flutter Project

Getting Started: Your First Steps

✨ Features

🛠 Tech Stack

📋 Prerequisites

Verify Installation

🚀 Getting Started: Your First Steps

1. Clone the Repository

2. Clean Up & Get Dependencies

3. Set Up Firebase: The Backend Power

3.1. Create Your Firebase Project

3.2. Connect Your Android App to Firebase

3.3. Connect Your iOS App to Firebase (Optional, if targeting iOS)

3.4. Deploy Firestore Rules (If you modify them)

4. Add AI Provider API Key

4. Configure Environment Variables

4.1. Create Your .env File

4.2. Get Your API Keys

5. Generate Code (Build Runner)

6. Run the Application

<<<<<<< HEAD

📁 Project Structure

🔧 Troubleshooting

Build Issues

MissingPluginException

Firebase Configuration Error

Build Cache Issues

Runtime Errors

Invalid BASE_API_URL

FocusNode Disposed Error

Firebase Issues

📚 Documentation

🤝 Contributing

📝 License

📧 Support

🙏 Acknowledgments

Happy Coding! 🚀

About

Topics

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages

4.1. Create Your `.env` File

`MissingPluginException`

`Firebase Configuration Error`

`Build Cache Issues`

`Invalid BASE_API_URL`

`FocusNode Disposed Error`