🌟 Hood Wink App

A powerful, scalable, and modern professional social platform built with Flutter

Crafted with ❤️ by the Flutter Team at RootPointers

🌍 Overview ✨ Features 🏗️ Architecture 📁 Structure 🚀 Quick Start 📐 Guidelines 👥 Team 🛠️ Tech Stack 📊 Stats 🔄 Changelog 📞 Support

🌍Overview

Hood Wink is a cutting-edge professional social platform designed to connect communities and facilitate meaningful interactions. Built with Flutter and Dart, it leverages a feature-first clean architecture, GetX for state management, and RESTful APIs for backend services. The app supports real-time professional social interactions, customizable user profiles, and a modern UI/UX, making it a scalable foundation for social networking.

This documentation serves as your comprehensive guide to understanding the project, setting it up, and navigating its features. Whether you're a developer working on the project or a stakeholder interested in its capabilities, you'll find everything you need to know right here!

✨Features

🔐 Authentication

Secure login/signup with email and password verification
Password reset functionality
Social login integration (Google, Apple, Facebook)

👤 User Profiles

Customizable profiles with bio and avatar
Privacy settings for posts and interactions
Media uploads (images, documents)

🏠 Social Interactions

Real-time feed with posts and updates
Post creation with supporting document evidence
Interactive comments and reaction system

🎨 UI/UX

Material Design 3 with smooth animations
Responsive layouts for all screen sizes
Font size customization for better user experience
Accessible design for inclusive user experiences

🔧 Additional Features

Push notifications for real-time updates
Advanced search capabilities
Content moderation and reporting system

📱 Frontend Documentation

The Hood Wink frontend is built with Flutter, following clean architecture principles and modern development practices.

🎨 UI Framework

Flutter SDK ^3.5.3
Material Design 3 components
Custom reusable widgets
Responsive layouts for all devices

🔄 State Management

GetX for reactive state management
Controller-based architecture
Dependency injection with GetX

🌐 API Integration

RESTful API consumption
DIO interceptors for auth
Error handling and retry logic

📂 Architecture

Feature-first clean architecture
Separation of concerns
Repository pattern for data access

Key Frontend Technologies:

Flutter Dart GetX Dio

🏗️Architecture Overview

We use a feature-first clean architecture, which organizes the codebase like a modular city:

🏬 Features: Independent modules (e.g., auth, profile, home) act like self-contained neighborhoods, each with its own UI, logic, and services.

🏛️ Core: Shared utilities (API clients, models, themes) serve as the city's infrastructure.

🧱 Widgets: Reusable UI components are like building blocks used across features.

⚙️ Services: External APIs and backend connections power the app's functionality.

📁Project Structure

The codebase is organized for clarity and ease of navigation. Here's the structure:

lib/
├── 🎯 features/                 # Feature modules (self-contained)
│   ├── 🔐 auth/                # Authentication feature
│   │   ├── login/
│   │   │   ├── view/           # UI components
│   │   │   └── controller/     # Business logic
│   │   ├── signup/
│   │   ├── otp/
│   │   ├── reset_password/
│   │   ├── password_change/
│   │   └── repository/           # Feature-specific API calls
│   │       └── auth_repository.dart
│   ├── 👤 profile/             # Profile management
│   │   ├── view/
│   │   ├── controller/
│   ├── 🏠 home/                # Social feed and interactions
│   │   ├── view/
│   │   └── controller/
│   └── [other features]/       # e.g., wink, notifications, search
├── 🏛️ core/                    # Shared utilities
│   ├── 🌐 api_services/        # Network and API handling
│   │   ├── interceptors/
│   │   └── endpoints/
│   ├── 📋 constants/           # App-wide configurations
│   ├── 🔧 extensions/          # Dart utility extensions
│   ├── 🌍 global/              # Global state and controllers
│   ├── 🧩 mixins/              # Reusable code snippets
│   ├── 📊 models/              # Data models
│   ├── 🎨 theme/               # App styling and themes
│   └── 🛠️ utils/               # Helper functions
├── 🧱 widgets/                 # Reusable UI components
├── 📱 main.dart                # App entry point
├── 🛠️ app.dart                 # App configuration
└── 🎨 assets.dart              # Asset management

🚀Quick Start for New Developers

Welcome to the Hood Wink project! Follow these steps to set up the project and start contributing:

📋 Prerequisites

Flutter SDK: Version ^3.5.3
Dart SDK: Included with Flutter
IDE: Android Studio or VS Code with Flutter/Dart plugins
Git: For version control

🛠️ Setup Instructions

1. Clone the Repository

git clone https://github.com/roootpointers/hood_wink
cd hood-wink

2. Install Dependencies

flutter pub get

3. Configure API Endpoints

Update the API endpoints in the configuration files with the provided credentials.

4. Run Code Generation

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

5. Launch the App

flutter run

💡 Tips for New Developers

Start with main.dart: Understand app initialization and entry point.
Explore features/: Each folder is a self-contained module.
Use core/utils/: Contains helper functions for validation, formatting, and more.
Check widgets/: Reusable UI components to speed up development.

📐Flutter Architecture Guidelines

To maintain a clean and consistent codebase, adhere to these principles:

Principle	Description	Why It Matters
Feature Isolation	Each feature (e.g., auth, profile) is self-contained with its own views, controllers, and services.	Prevents code tangling and simplifies debugging.
No Logic in UI	Business logic belongs in controllers, not in view/ files.	Ensures reusable and testable code.
Reusable Core	Use core/ for shared utilities like API clients, models, and themes.	Reduces duplication and ensures consistency.
Minimal Dependencies	Avoid heavy third-party packages unless justified.	Keeps the app lightweight and maintainable.
Consistent Naming	Follow naming conventions (e.g., _view.dart, _controller.dart).	Improves code readability and navigation.

📊Project Stats

~14K

Lines of Code

Major Features

Platforms

Features: auth, profile, home, winks, notifications, search, setting | Platforms: iOS, Android | Minimum Flutter Version: 3.5.3

Principle	Description	Why It Matters
Fat Models, Thin Views	Business logic goes in models and services, not views.	Promotes reusability and testability.
App Separation	Each Django app handles one business domain (auth, profiles, posts).	Prevents coupling and simplifies maintenance.
DRF Best Practices	Use serializers for validation, viewsets for CRUD operations.	Ensures consistent API design and validation.
Service Layer	Complex business logic belongs in service classes.	Keeps views clean and logic reusable.
Environment Settings	Separate settings for development, testing, and production.	Prevents configuration errors and security issues.

👥Meet the Team

🏆 Flutter Team at RootPointers

Team Lead

Wahab Sohail

Architecture design, project oversight, code reviews

Senior Developer

Baber Ibrar(Backend Developer)

API architecture, database design, backend logic, and GitHub management

Senior Developer

Asad Ullah (Mobile App Developer)

Core feature development, performance optimization, GitHub management

UI/UX Developer

M Sami

Design system, UI implementation, user experience

We're passionate about building logical, performant, and beautiful Flutter apps!

🛠️Tech Stack

Category	Technologies	Purpose
📱 Mobile Frontend	Flutter 3.5.3+ Dart 3.0+ Material Design 3 Cupertino Widgets	Cross-platform mobile app development with native performance
🧠 State Management	GetX Reactive Programming	Efficient state management, dependency injection, and navigation
⚙️ Backend Framework	Django 4.2 LTS Python 3.11+ Django REST Framework djangorestframework-simplejwt	Robust web framework with REST API capabilities and JWT authentication
🗄️ Database & Cache	PostgreSQL 14+ Redis 6+ django-redis psycopg2-binary	Reliable data storage with in-memory caching for performance
☁️ File Storage	AWS S3 django-storages boto3 Pillow	Scalable cloud storage for user media and static files
🔐 Authentication	JWT Tokens Django Auth flutter_secure_storage dio_interceptors	Secure user authentication with token-based session management
🌐 API & Networking	Dio HTTP Client Django REST Framework django-cors-headers drf-spectacular	HTTP client for API calls with automatic documentation generation
🔔 Notifications	Firebase Cloud Messaging firebase_messaging fcm-django Celery	Real-time push notifications with background task processing
🔧 Code Generation	build_runner json_serializable json_annotation	Automated code generation for serialization and database schemas

Version Compatibility: Flutter 3.5.3+ • Django 4.2 LTS • Python 3.11+ • PostgreSQL 14+ (development tools)

📞 Support

Need Help? Contact the Team!

📧 Email
flutter@rootpointers.com

🙏Acknowledgments

Flutter Team: For the amazing framework that powers this app.
GetX Community: For providing a clean and powerful state management solution.
Development Team: For their dedication and expertise in building this platform.
Client Team: For their vision and support throughout the development process.

🌟 Hood Wink - Connecting Communities

Built with ❤️ by the Flutter Team at RootPointers

Creating meaningful social connections, one feature at a time.

🌟 Hood Wink App

🌍Overview

✨Features

🔐 Authentication

👤 User Profiles

🏠 Social Interactions

🎨 UI/UX

🔧 Additional Features

📱 Frontend Documentation

🎨 UI Framework

🔄 State Management

🌐 API Integration

📂 Architecture

Key Frontend Technologies:

🏗️Architecture Overview

🏬 Features: Independent modules (e.g., auth, profile, home) act like self-contained neighborhoods, each with its own UI, logic, and services.

🏛️ Core: Shared utilities (API clients, models, themes) serve as the city's infrastructure.

🧱 Widgets: Reusable UI components are like building blocks used across features.

⚙️ Services: External APIs and backend connections power the app's functionality.

📁Project Structure

🚀Quick Start for New Developers

📋 Prerequisites

🛠️ Setup Instructions

1. Clone the Repository

2. Install Dependencies

3. Configure API Endpoints

4. Run Code Generation

5. Launch the App

💡 Tips for New Developers

📐Flutter Architecture Guidelines

📊Project Stats

⚙️ Django Backend Documentation

🏗️Architecture Overview

📱 Apps: Django apps (auth, profiles, posts, notifications) act like specialized districts, each handling specific business domains.

🗄️ Models: Database models serve as the foundation, defining data structure and relationships.

🎯 Views: API views and viewsets handle HTTP requests and orchestrate business logic.

🔗 URLs: URL routing connects endpoints to appropriate views, like street addresses.

🛠️ Services: Business logic services keep views clean and promote code reuse.

🔧 Utils: Shared utilities and helpers support the entire application ecosystem.

Why Django MVC?

📁Project Structure

🚀Quick Start for New Developers

📋 Prerequisites

🛠️ Setup Instructions

1. Clone the Repository

2. Create Virtual Environment

3. Environment Configuration

4. Database Setup

5. Run Development Server

6. Alternative: Docker Setup

💡 Tips for New Developers

📐Django Architecture Guidelines

📊Project Stats

👥Meet the Team

🏆 Flutter Team at RootPointers

🛠️Tech Stack

🙏Acknowledgments