Skip to content

README.md

Latest commit

 

History

History
225 lines (177 loc) · 5.44 KB

README.md

File metadata and controls

225 lines (177 loc) · 5.44 KB

ChatFlow - Real-Time Messaging Application

🚀 About The Project

ChatFlow is a modern and user-friendly real-time messaging application. Built with Flutter framework, it provides seamless functionality across both iOS and Android platforms.

📱 Screenshots

Login View
Login View 		Register View
Register View 		Home View
Home View
Chat View
Chat View 		Users View
Users View 		Profile View
Profile View

📂 Project Structure

lib/
├── core/
│   ├── base/
│   │   ├── model/              # Base model interfaces
│   │   └── view/               # Base view classes
│   ├── bloc/                   # Global BLoC states
│   ├── constants/              # App constants
│   ├── init/
│   │   ├── network/           # Network layer management
│   │   ├── cache/             # Local storage management
│   │   ├── notification/      # Push notification setup
│   │   └── theme/             # App theme configuration
│   ├── models/                # Data models
│   └── service/               # API services
├── feature/
│   ├── auth/                  # Authentication feature
│   │   ├── login/
│   │   └── register/
│   ├── chat/                  # Chat feature
│   ├── home/                  # Home feature
│   └── profile/               # Profile feature
└── main.dart

🔍 Case Studies

1. Network Layer Implementation

The project includes a robust network layer implementation with the following features:

Network Manager

  • Singleton pattern for network operations
  • Generic response handling
  • Type-safe API calls
  • Automatic error handling
Future<R?> send<T extends INetworkModel<T>, R>({
  required String path,
  required RequestType type,
  required T parseModel,
  Map<String, dynamic>? queryParameters,
  Map<String, dynamic>? data,
})

Base Network Model

  • Generic base model for all network responses
  • Type-safe JSON parsing
abstract class INetworkModel<T> {
  T fromJson(Map<String, dynamic> json);
  Map<String, dynamic> toJson();
}

2. Service Layer Implementation

Example service implementation showing CRUD operations:

abstract class IPostService {
  Future<List<PostModel>?> getPosts();
  Future<PostModel?> getPost(int id);
  Future<PostModel?> createPost(String title, String body, int userId);
  Future<PostModel?> updatePost(int id, String title, String body);
  Future<bool> deletePost(int id);
}

✨ Features

🔐 Authentication

  • Secure session management with JWT
  • User registration and login
  • Secure password storage

💬 Real-Time Chat

  • Instant messaging with Firebase Realtime Database
  • Typing indicators
  • Message read/unread status
  • Last seen feature

🔔 Notifications

  • Firebase Cloud Messaging (FCM) integration
  • Customizable notification settings
  • In-app notification management

👤 User Profile

  • Profile creation and editing
  • Profile picture upload with Firebase Storage
  • User settings management

🛠 Technical Features

  • Clean Architecture principles
  • State management with BLoC pattern
  • Firebase services integration
  • Comprehensive error handling
  • Unit and widget tests
  • Generic network layer
  • Type-safe API calls

🔧 Installation

  1. Prerequisites:

    • Flutter SDK (latest version)
    • Dart SDK (latest version)
    • Android Studio / VS Code
    • Firebase account

  2. Clone the project:

    git clone [repo-url]
cd chat_flow

  3. Install dependencies:

    flutter pub get

  4. Configure Firebase:

    • Add your google-services.json for Android
    • Add your GoogleService-Info.plist for iOS

  5. Run the app:

    flutter run

🧪 Testing

Run tests using:

flutter test

📚 Documentation

For detailed documentation about the implementation:

📱 Supported Platforms

  • iOS 11.0 and above
  • Android 5.0 (API level 21) and above

🤝 Contributing

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

📄 License

This project is licensed under the MIT License.

📸 Directory Structure for Screenshots

screenshots/
├── login.png
├── chat_list.png
├── chat_detail.png
└── profile.png

Note: Please add your application screenshots to the screenshots directory following the structure above.