diff --git a/README.md b/README.md new file mode 100644 index 0000000..48a0879 --- /dev/null +++ b/README.md @@ -0,0 +1,163 @@ +# Hankers — Cross-Platform Mobile App + +
+ Hankers Logo +

Modern Social Networking App — Flutter

+

A scalable, cross-platform mobile application for the Hankers platform

+

Built once, deployed everywhere — Android & iOS

+ 🔗 Live Platform: hankers.tech +
+ +--- + +## 📌 Overview + +**Hankers Mobile App** is a **production-ready cross-platform application** built with **Flutter** and **Dart**, designed to deliver a smooth, high-performance social networking experience on **Android and iOS**. + +The app follows a **feature-first, layered architecture**, aligning closely with the Hankers frontend and backend systems. It prioritizes: + +- Maintainability and scalability +- Clean architecture principles +- Predictable state management +- Real-world mobile engineering practices + +--- + +## ✨ Key Mobile Features + +* 🔐 **Authentication** + - Login, signup, OTP verification + - Secure token handling + - Persistent sessions + +* 📰 **Home Feed** + - Infinite scrolling timeline + - Posts, replies, likes, reposts + - Optimized API pagination + +* 👤 **User Profiles** + - Avatars, bios, cover photos + - Follow / unfollow users + - Profile editing + +* 🔍 **Explore & Search** + - Trending topics & hashtags + - User and post search + - Filters & sorting + +* 💬 **Messaging** + - Real-time one-to-one chats + - Group conversations + - Typing & read indicators + +* 🔔 **Notifications** + - Real-time updates + - Push notification support + - Unread badge tracking + +* ⚙️ **Settings** + - Account & privacy controls + - Notification preferences + - Theme & language options + +--- + +## 🧱 Architecture Philosophy + +The mobile app follows **Clean Architecture** adapted for Flutter, with a **Feature-First structure**. + +Each feature is: + +- Isolated and independently testable +- Separated into presentation, domain, and data layers +- Easy to scale and refactor + +> ✅ This approach is widely used in production Flutter apps and large teams. + +--- + +## 🛠 Tech Stack + +### Core + +- **Framework**: Flutter +- **Language**: Dart +- **Platforms**: Android, iOS + +### State & Architecture + +- **State Management**: BLoC / Cubit +- **Architecture**: Clean Architecture +- **Dependency Injection**: get_it / injectable + +### Data & Networking + +- **API Communication**: REST +- **HTTP Client**: Dio +- **Serialization**: json_serializable +- **Local Storage**: SharedPreferences / Hive + +### Real-Time & Notifications + +- **WebSockets**: Socket.IO / native sockets +- **Push Notifications**: Firebase Cloud Messaging (FCM) + +### Testing & Quality + +- **Unit Tests**: flutter_test +- **Widget Tests** +- **Integration Tests** +- **Linting**: flutter_lints + +--- + +## 🚀 Getting Started + +### 1️⃣ Install Dependencies + +```bash +flutter pub get +``` + +--- + +### 🔄 Cross Team + + + + + + + + +
+ + +
+ Ziad Montaser +
+
+ + +
+ Farouk Mohamed +
+
+ + +
+ Hossam Mohamed +
+
+ + +
+ Mohamed Yasser +
+
+ + +
+ Mazen Hatem +
+