Skip to content

Repository files navigation

SparqTest

An Android application demonstrating modern Android development practices with a modular architecture based on Clean Architecture principles.

Architecture

The application follows a three-layer architecture:

  • Data Layer: Handles data operations and serves as a single source of truth
  • Domain Layer: Contains business logic and use cases
  • Presentation Layer: Handles UI components and user interactions

Key Features

  • Clean Architecture: Separation of concerns with clearly defined layers
  • Offline-First Approach: Prioritizes local data and handles network errors gracefully
  • MVVM Pattern: Separation of UI and business logic
  • Dependency Injection: Using Hilt for DI throughout the app
  • Modern UI: Built with Jetpack Compose
  • Pull-to-Refresh: Integrated with Material 3 components
  • Unit Testing: Comprehensive test coverage for ViewModel and Repository

Technologies Used

  • Kotlin: Modern language for Android development
  • Jetpack Compose: Declarative UI toolkit
  • Room: Local database for caching
  • Retrofit: Type-safe HTTP client for API communication
  • Hilt: Dependency injection library
  • Kotlin Coroutines & Flow: Asynchronous programming
  • Material 3: Modern design system components

Getting Started

  1. Clone the repository
  2. Open the project in Android Studio
  3. Build and run the application

Testing

The application includes unit tests for the ViewModel and Repository implementations. Run the tests using:

./gradlew test

License

MIT License

Copyright (c) 2023

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages