How shivamsharma-1996/piechatapp works
Project type and purpose
• Project type: Android mobile application
• Purpose: Real-time chat app with offline message queuing using PieSocket WebSocket service
• Architecture style: MVVM + Clean Architecture + SOLID principles
File structure
Top-level directories and important files
• app/src/main/java/com/shivam/piechatapp/presentation – Jetpack Compose UI components, screens, ViewModels, navigation
• app/src/main/java/com/shivam/piechatapp/domain – Entities, repository interfaces, use cases, domain services (message queue service)
• app/src/main/java/com/shivam/piechatapp/data – Implementations of repositories, network monitors, queue managers, handlers
• app/src/main/java/com/shivam/piechatapp/di – Dagger-Hilt module for wiring dependencies
• manifest, resources (themes, layouts, drawables) under app/src/main/res
• test and androidTest for unit and instrumented tests
Configuration and build
• build.gradle.kts files (project and app level), gradle wrapper, proguard rules
README for additional insights
• Tech stack: Kotlin, Jetpack Compose, Material Design, Coroutines + Flow, Dagger-Hilt, PieSocket SDK
• Core features: real-time messaging over WebSocket, offline queuing, auto-retry, network status alerts
• Data flow overview: UI → ViewModel → UseCase → Repository → DataSource (network or queue) → external WebSocket → back up through layers via Flow
Main components
a. Presentation Layer
– UI Screens (ConversationsScreen, ChatScreen)
– UI Components (AppTopBar, ConversationItem, ChatMessageItem, NetworkAlert)
– ViewModels (ConversationsViewModel, ChatViewModel)
– Navigation Graph (PieChatNavigation)
b. Domain Layer
– Models (ChatMessage, Conversation, ConnectionStatus, MessageStatus)
– Repository Interfaces (ConversationRepository, WebSocketRepository)
– Use Cases (GetConversationsUseCase, SendMessageUseCase, GetConnectionStatusUseCase)
– Domain Services (MessageQueueService)
c. Data Layer
– Repository Implementations (ConversationRepositoryImpl, PieSocketWebSocketRepository)
– Network Monitoring (NetworkMonitor, NetworkStatusManager)
– Message Handling (MessageHandler)
– Offline Queue Management (MessageQueue, QueueSimulationManager)
d. Infrastructure/DI
– Dagger-Hilt AppModule providing bindings for repositories, services, managers
e. External Services
– PieSocket WebSocket endpoint (wss://…/chat-shivam)
– Device network connectivity
Relationships and interactions
• UI emits user actions (send message, load conversations) → ViewModel
• ViewModel calls UseCase → interacts with Repository Interface
• Repository implementation delegates to:
– Online: PieSocketWebSocketRepository (WebSocket send/receive)
– Offline: MessageQueueService + MessageQueue (local in-memory or persistent store)
• NetworkStatusManager monitors connectivity → notifies domain/service layer → triggers queue flush when back online
• Handlers (MessageHandler) process incoming and outgoing messages, map DTOs to domain models
• All asynchronous communication via Kotlin Flow → observed by ViewModels → UI updates
Important architectural patterns and design principles
• Clean Architecture separation: presentation, domain, data
• MVVM in presentation with unidirectional data flow
• Dependency Injection with Dagger-Hilt for decoupling
• Repository pattern for data sources
• Service layer for queue management and network operations
• Use of Coroutines + Flow for reactive, asynchronous streams
• SOLID principles for single responsibility, open/closed modules
3. In Domain layer, show UseCases and Domain Services; link ViewModels to UseCases
4. In Data layer, group repository implementations, network manager, queue manager, handlers; link UseCases to appropriate repos/services