Git Product home page Git Product logo

photo-album's Introduction

PhotoAlbum App

This application leverages the JSONPlaceholder API to exhibit album lists and the associated photo details.

Application Structure ๐Ÿ“š

This project primarily adopts the Model-View-ViewModel (MVVM) pattern and certain principles of clean architecture, emphasizing the separation of concerns and encapsulation. Despite not strictly adhering to every facet of clean architecture, such as the absence of Use Cases and exact division of modules like Domain and Data, the application is designed with a focus on maintainability and scalability.

โ””โ”€โ”€ photo-album
    โ”œโ”€โ”€ data  // Handles API response models and network requests
    โ”‚   โ””โ”€โ”€ remote
    โ”‚       โ””โ”€โ”€ model (AlbumModel.kt, PhotoModel)
    โ”‚       โ””โ”€โ”€ WebService
    โ”œโ”€โ”€ di  // Contains all dependencies, provided in AppModule
    โ”‚   โ””โ”€โ”€ AppModule
    โ”œโ”€โ”€ domain  // Hosts business logic components (repositories, mappers)
    โ”‚   โ”œโ”€โ”€ model (AlbumItem, PhotoItem)
    โ”‚   โ”œโ”€โ”€ PhotoMapper
    โ”‚   โ””โ”€โ”€ PhotoRepository
    โ”œโ”€โ”€ ui  // Houses UI-related classes (components, screens)
    โ”‚   โ”œโ”€โ”€ album (AlbumScreen, AlbumUiState, AlbumViewModel)
    โ”‚   โ”œโ”€โ”€ component (AlbumCard, DetailView, ErrorView, PhotoCard)
    โ”‚   โ”œโ”€โ”€ photo (PhotoDetailScreen, PhotoScreen, PhotoUiState, PhotoViewModel)
    โ”‚   โ”œโ”€โ”€ theme // Contains classes related to the application's UI.
    โ”‚   โ””โ”€โ”€ MainActivity
    โ”œโ”€โ”€ util  // Includes utility and exception handling classes
    โ”‚   โ”œโ”€โ”€ exception (AppException, ExceptionExtension)
    โ”‚   โ”œโ”€โ”€ Constant
    โ”‚   โ”œโ”€โ”€ Route
    โ”‚   โ””โ”€โ”€ UiUtil
    โ””โ”€โ”€ PhotoAlbumApp

Features ๐Ÿš€

  • Displays all available albums.
  • Shows photos within each album.
  • Provides a detailed view for each photo.
  • Asynchronous data loading.
  • Utilizes popular libraries for network requests and dependency injection.

Tech Stack ๐Ÿ’ป

The following libraries and tools were utilized in the project:

  • Kotlin as the main language.
  • Jetpack Compose for building the UI.
  • AndroidX Paging Library for handling pagination in the application.
  • Navigation-Compose for handling in-app navigation.
  • Coil for image loading.
  • Kotlin Coroutines & Flow for handling asynchronous tasks.
  • Hilt for dependency injection.
  • Retrofit for making network requests.
  • OkHttp3 for implementing interceptor, logging and networking.
  • GSON Converter for parsing JSON.
  • JUnit, MockK and Kotlinx Coroutines Test for Testing.

Future Improvements ๐Ÿ› 

While the project is functional and robust, there are areas that could see improvements in the future:

  • Paging: Since the JSONPlaceholder API does not support pagination, the app currently does not feature pagination capabilities. If the API were to support it in the future, pagination would be an ideal addition.
  • Expanded Test Coverage: More comprehensive unit and UI tests to ensure the app's stability.
  • User Experience: Refine the UI and UX design of the app for a more engaging user experience.

photo-album's People

Contributors

dranoer avatar

Watchers

 avatar

photo-album's Issues

KMM

Migrate to KMM

Set up project structure

Initialize the project with the MVVM architecture, adding necessary dependencies in Gradle file, setting up packages.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.