How tylercarberry/ptsd-aid works
Main Components
a. Client-Side (Android App)
• UI Layer
• Main Activity (MainActivity.java)
• Fragment Components (MainFragment, PTSDTestFragment, ResourcesFragment, etc.)
• Dialog Components (FeedbackDialog, RatingDialog)
b. Core Features
• PTSD Test Module
• Resources Module
• VA Facilities Module
• News Module
• Trusted Contact System
c. External Services
• VA API Integration (VaClient)
• News Service Integration (NewsClient)
• Firebase Services
• Remote Config
• Cloud Messaging
Architecture Patterns to Highlight
• Dependency Injection (Show PtsdComponent and related modules)
• Fragment-based Navigation
• Database Systems (PhoneDatabase, WebsiteDatabase)
• Service Layer (PtsdMessagingService)
┌─ User Interface Layer ─────────────────────────┐
• Activities → Fragments → Dialogs → Adapters │
• Feature Modules ───────────────────────────────┤
• PTSD Test │ Resources │ VA Facilities │ News │
• Core Services ────────────────────────────────┤
• Dependency Injection │ Remote Config │ Utils │
• Data Layer ──────────────────────────────────┤
• Phone DB │ Website DB │ Preferences │
• External Services ─────────────────────────────┤
• VA API │ News Service │ Firebase │
• ┘
Important Relationships
• Navigation flow between fragments
• Data flow from VA API to facilities display
• News service integration
• Firebase service connections
• Database interactions
• Dependency injection relationships
Implementation Details
• Maintain a hierarchical layout for clear visualization
• Version information and build configuration
• Integration with CircleCI for continuous integration
Remember to include annotations for key architectural decisions and any scalability considerations for future feature additions.