DSG Store Finder

Locate DICK'S Sporting Goods stores using ZIP codes or their current location.

Architecture Components

This app follows Clean Architecture principles with MVVM pattern

DSCG Store Finder

1. Data Layer

• StoreApiService: Interface for making API calls to the DSG store search endpoint
• StoreRepository: Handles data operations and transforms API responses to UI models
• Data Models: StoreResponse, Store, StoreUiModel
• API Security: Keys stored in gradle.properties and accessed via BuildConfig

2. Domain Layer

• LocationProvider: Utility for accessing the device's location

3. UI Layer

• StoreSearchViewModel: Connects UI with the repository and manages UI state
• StoreSearchScreen: Main composable screen for searching stores
• UI Components: SearchBar, StoreList, StoreItem, ErrorMessage

4. Dependency Injection

• AppModule: Provides application context
• NetworkModule: Provides Retrofit, OkHttp, and API service instances

5. Tests

• StoreSearchViewModelTest: Unit tests for the ViewModel
• StoreRepositoryTest: Unit tests for the Repository

6. Navigation

• Single-Activity Architecture: Utilizes Jetpack Navigation for Compose
• NavigationRoute: Defines app navigation destinations
• NavHost: Centralized navigation graph in MainActivity
• External Intent Integration: Seamlessly launches external map applications

Features

1. Search stores by ZIP code

• User can enter a ZIP code and search for nearby stores
• Displays a list of stores within 100 miles of the ZIP code

2. Search stores by current location

• User can use their device's GPS to find nearby stores
• Handles location permission requests appropriately

3. Store List Display

• Shows store name, distance, and city/state
• Handles empty states when no stores are found

4. Error Handling

• Displays appropriate error messages when API calls fail
• Handles location permission denials and errors
• 404 responses mapped to success with empty list for better UX

5. Security

• API keys stored securely in gradle.properties (excluded from version control)
• Keys accessed at build-time via BuildConfig fields
• Consistent error handling prevents sensitive information exposure

6. Modern Navigation Implementation

• Migrated from multi-activity architecture to single-activity with Compose Navigation
• Removed MapDetailActivity in favor of direct map app integration

7. Optimized Map Integration

• Created MapUtils utility class for clean external map app launching
• Streamlined navigation flow when opening location in maps

Setup Instructions

1. Clone the repository
2. Create a gradle.properties file in the project root
3. Add the following line to your gradle.properties file: API_KEY=code-challenge
4. Sync the project with Gradle files
5. Build and run the application

Requirements

• Android Studio Hedgehog or later
• Minimum SDK: 24 (Android 7.0)
• Target SDK: 35
• Kotlin 1.9.0 or later

Libraries Used

• Jetpack Compose for UI
• Jetpack Navigation for Compose
• Retrofit for network calls
• Hilt for dependency injection
• Kotlin Coroutines and Flow
• Google Play Services Location API