Skip to content

Software-Guardians/AndroidJetpackComposeRetrofitPhotoViewer

BranchesTags

Repository files navigation

Android Jetpack Compose Photo Viewer Application with using Retrofit

EN

Android Jetpack Compose Photo Viewer Application 📸

Kotlin Android Jetpack Compose Retrofit Hilt License: MIT GitHub Stars GitHub Forks

A modern and elegant photo viewer application built using Android Jetpack Compose, designed for a smooth and intuitive user experience. This project demonstrates the integration of robust network capabilities with Retrofit, a scalable architecture following the MVVM pattern, and efficient dependency management with Hilt.

🌟 Description

This application serves as a dynamic photo viewer, fetching a collection of photos from a remote API and displaying them in a beautifully crafted user interface powered by Jetpack Compose. It's engineered to showcase best practices in Android development, including a clear separation of concerns, reactive UI updates, and robust data handling. Users can browse through a list of images and dive into the details of each photo, offering a comprehensive example of a production-ready Android application.

✨ Features

The application incorporates a variety of modern Android development features:

  • Android Jetpack Compose: Declarative UI toolkit for building native Android UIs.
  • Retrofit: Type-safe HTTP client for Android and Java to consume RESTful APIs.
  • MVVM (Model-View-ViewModel): A clean architectural pattern for separating UI logic from business logic.
  • Singleton Pattern: Ensures a single instance of critical classes for resource optimization.
  • Hilt: Dependency Injection library built on top of Dagger for simplifying DI in Android apps.
  • Navigation Compose: Handles in-app navigation between composable destinations.
  • API Integration: Fetches photo data from a remote source.

🚀 Installation

To get this project up and running on your local machine, follow these steps:

  1. Clone the Repository: 
    git clone https://github.com/Software-Guardians/AndroidJetpackComposeRetrofitPhotoViewer.git
  2. Open in Android Studio: Navigate to the cloned directory and open the project in Android Studio.
  3. Sync Gradle Project: Android Studio will automatically prompt you to sync the Gradle project. If not, manually trigger it via File > Sync Project with Gradle Files.
  4. Build and Run: Select your desired emulator or physical device and click the "Run" button (the green triangle icon) in Android Studio.

💡 Usage

Once the application is successfully installed and launched:

  1. Launch the App: The application will start on the main screen, which displays a grid or list of photos.
  2. View Photos: Photos fetched from the configured remote API will populate the screen. You can scroll through the list to discover more images.
  3. Explore Details: Tap on any photo to navigate to a detailed view, where you can see more information or properties related to that specific image.

📁 Project Structure

The project follows a modular and clean architecture, making it easy to understand and maintain. Here's a high-level overview of the key directories:

.
├── app/
│   ├── src/
│   │   ├── main/
│   │   │   ├── java/
│   │   │   │   └── com/emrullaheniscetinkaya/photoapplication/
│   │   │   │       ├── dependencies/    // Hilt application setup and modules
│   │   │   │       ├── entities/        // Data models for photos
│   │   │   │       ├── services/        // API service interfaces, Retrofit client, and repository
│   │   │   │       ├── screens/         // UI composables (MainScreenCompose, PropertiesScreen)
│   │   │   │       ├── ui/              // UI related components like theme, color, type
│   │   │   │       ├── viewmodels/      // ViewModel classes for UI logic and data
│   │   │   │       └── MainActivity.kt  // Main entry point of the application
│   │   │   └── res/                     // Android resources (layouts, drawables, values)
│   │   └── androidTest/                 // Instrumented tests
│   │   └── test/                        // Unit tests
│   └── build.gradle.kts                 // Module-level Gradle build file
├── gradle/                              // Gradle wrapper files
├── .gitignore                           // Git ignore rules
├── build.gradle.kts                     // Project-level Gradle build file
├── settings.gradle.kts                  // Gradle settings
├── gradlew                              // Gradle wrapper executable (Linux/macOS)
├── gradlew.bat                          // Gradle wrapper executable (Windows)
└── LICENSE                              // Project license file

🤝 Contribution

Contributions are welcome! If you have suggestions for improvements, new features, or bug fixes, please follow these steps:

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature/AmazingFeature).
  3. Commit your changes (git commit -m 'Add some AmazingFeature').
  4. Push to the branch (git push origin feature/AmazingFeature).
  5. Open a Pull Request.

Please ensure your code adheres to standard Kotlin/Android style guidelines and includes appropriate tests.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

✒️ Author

Emrullah Enis Çetinkaya GitHub Profile

Date: 2025

TR

Android Jetpack Compose Fotoğraf Görüntüleyici Uygulaması 📸

Kotlin Android Jetpack Compose Retrofit Hilt License: MIT GitHub Stars GitHub Forks

Android Jetpack Compose kullanılarak oluşturulmuş, pürüzsüz ve sezgisel bir kullanıcı deneyimi için tasarlanmış modern ve zarif bir fotoğraf görüntüleyici uygulaması. Bu proje, Retrofit ile güçlü ağ yeteneklerinin, MVVM desenini takip eden ölçeklenebilir bir mimarinin ve Hilt ile verimli bağımlılık yönetiminin entegrasyonunu göstermektedir.

🌟 Açıklama

Bu uygulama, uzak bir API'den bir fotoğraf koleksiyonunu alıp Jetpack Compose tarafından desteklenen güzelce hazırlanmış bir kullanıcı arayüzünde görüntüleyerek dinamik bir fotoğraf görüntüleyici olarak hizmet vermektedir. Endişelerin net bir şekilde ayrılması, reaktif UI güncellemeleri ve sağlam veri işleme dahil olmak üzere Android geliştirmede en iyi uygulamaları sergilemek üzere tasarlanmıştır. Kullanıcılar bir görüntü listesinde gezinebilir ve her fotoğrafın detaylarına inerek üretime hazır bir Android uygulamasının kapsamlı bir örneğini sunar.

✨ Özellikler

Uygulama, çeşitli modern Android geliştirme özelliklerini içermektedir:

  • Android Jetpack Compose: Yerel Android kullanıcı arayüzleri oluşturmak için bildirimsel UI araç seti.
  • Retrofit: RESTful API'leri tüketmek için Android ve Java için tip güvenli HTTP istemcisi.
  • MVVM (Model-View-ViewModel): UI mantığını iş mantığından ayırmak için temiz bir mimari desen.
  • Singleton Deseni: Kaynak optimizasyonu için kritik sınıfların tek bir örneğini sağlar.
  • Hilt: Android uygulamalarında DI'ı basitleştirmek için Dagger üzerine inşa edilmiş Bağımlılık Enjeksiyonu kütüphanesi.
  • Navigation Compose: Oluşturulabilir hedefler arasında uygulama içi gezinmeyi yönetir.
  • API Entegrasyonu: Uzak bir kaynaktan fotoğraf verilerini çeker.

🚀 Kurulum

Bu projeyi yerel makinenizde çalıştırmak için şu adımları izleyin:

  1. Depoyu Klonlayın: 
    git clone https://github.com/Software-Guardians/AndroidJetpackComposeRetrofitPhotoViewer.git
  2. Android Studio'da Açın: Klonlanmış dizine gidin ve projeyi Android Studio'da açın.
  3. Gradle Projesini Senkronize Edin: Android Studio otomatik olarak Gradle projesini senkronize etmenizi isteyecektir. İstemezse, File > Sync Project with Gradle Files üzerinden manuel olarak tetikleyin.
  4. Derleyin ve Çalıştırın: İstediğiniz emülatörü veya fiziksel cihazı seçin ve Android Studio'da "Çalıştır" düğmesine (yeşil üçgen simgesi) tıklayın.

💡 Kullanım

Uygulama başarıyla yüklendikten ve başlatıldıktan sonra:

  1. Uygulamayı Başlatın: Uygulama, fotoğrafların bir ızgarasını veya listesini gösteren ana ekranda başlayacaktır.
  2. Fotoğrafları Görüntüleyin: Yapılandırılan uzak API'den çekilen fotoğraflar ekranı dolduracaktır. Daha fazla görüntü keşfetmek için listede gezinebilirsiniz.
  3. Detayları Keşfedin: Belirli bir görselle ilgili daha fazla bilgi veya özellik görebileceğiniz detaylı bir görünüme gitmek için herhangi bir fotoğrafa dokunun.

📁 Proje Yapısı

Proje, anlaşılması ve bakımı kolaylaştıran modüler ve temiz bir mimariyi takip eder. İşte ana dizinlerin yüksek seviyeli bir genel bakışı:

.
├── app/
│   ├── src/
│   │   ├── main/
│   │   │   ├── java/
│   │   │   │   └── com/emrullaheniscetinkaya/photoapplication/
│   │   │   │       ├── dependencies/    // Hilt application setup and modules
│   │   │   │       ├── entities/        // Data models for photos
│   │   │   │       ├── services/        // API service interfaces, Retrofit client, and repository
│   │   │   │       ├── screens/         // UI composables (MainScreenCompose, PropertiesScreen)
│   │   │   │       ├── ui/              // UI related components like theme, color, type
│   │   │   │       ├── viewmodels/      // ViewModel classes for UI logic and data
│   │   │   │       └── MainActivity.kt  // Main entry point of the application
│   │   │   └── res/                     // Android resources (layouts, drawables, values)
│   │   └── androidTest/                 // Instrumented tests
│   │   └── test/                        // Unit tests
│   └── build.gradle.kts                 // Module-level Gradle build file
├── gradle/                              // Gradle wrapper files
├── .gitignore                           // Git ignore rules
├── build.gradle.kts                     // Project-level Gradle build file
├── settings.gradle.kts                  // Gradle settings
├── gradlew                              // Gradle wrapper executable (Linux/macOS)
├── gradlew.bat                          // Gradle wrapper executable (Windows)
└── LICENSE                              // Project license file

🤝 Katkıda Bulunma

Katkılar memnuniyetle karşılanır! İyileştirmeler, yeni özellikler veya hata düzeltmeleri için önerileriniz varsa, lütfen şu adımları izleyin:

  1. Depoyu Fork edin.
  2. Yeni bir dal Oluşturun (git checkout -b feature/AmazingFeature).
  3. Değişikliklerinizi Commit edin (git commit -m 'Add some AmazingFeature').
  4. Dala Push edin (git push origin feature/AmazingFeature).
  5. Bir Pull Request Açın.

Lütfen kodunuzun standart Kotlin/Android stil yönergelerine uygun olduğundan ve uygun testleri içerdiğinden emin olun.

📄 Lisans

Bu proje MIT Lisansı altında lisanslanmıştır - ayrıntılar için LICENSE dosyasına bakın.

✒️ Yazar

Emrullah Enis Çetinkaya GitHub Profili

Tarih: 2025

DE

Android Jetpack Compose Foto-Betrachter-Anwendung 📸

Kotlin Android Jetpack Compose Retrofit Hilt License: MIT GitHub Stars GitHub Forks

Eine moderne und elegante Foto-Betrachter-Anwendung, die mit Android Jetpack Compose erstellt wurde und für eine reibungslose und intuitive Benutzererfahrung konzipiert ist. Dieses Projekt demonstriert die Integration robuster Netzwerkfunktionen mit Retrofit, einer skalierbaren Architektur nach dem MVVM-Muster und einem effizienten Abhängigkeitsmanagement mit Hilt.

🌟 Beschreibung

Diese Anwendung dient als dynamischer Foto-Betrachter, der eine Sammlung von Fotos von einer Remote-API abruft und diese in einer wunderschön gestalteten Benutzeroberfläche, die von Jetpack Compose angetrieben wird, anzeigt. Sie wurde entwickelt, um Best Practices in der Android-Entwicklung zu demonstrieren, einschließlich einer klaren Trennung der Belange, reaktiver UI-Updates und robuster Datenverarbeitung. Benutzer können eine Liste von Bildern durchsuchen und in die Details jedes Fotos eintauchen, was ein umfassendes Beispiel für eine produktionsreife Android-Anwendung bietet.

✨ Funktionen

Die Anwendung integriert eine Vielzahl moderner Android-Entwicklungsfunktionen:

  • Android Jetpack Compose: Deklaratives UI-Toolkit zum Erstellen nativer Android-UIs.
  • Retrofit: Typensicherer HTTP-Client für Android und Java zum Konsumieren von RESTful APIs.
  • MVVM (Model-View-ViewModel): Ein sauberes Architekturmuster zur Trennung von UI-Logik und Geschäftslogik.
  • Singleton-Muster: Gewährleistet eine einzige Instanz kritischer Klassen zur Ressourcenoptimierung.
  • Hilt: Dependency Injection-Bibliothek, die auf Dagger aufbaut, zur Vereinfachung von DI in Android-Apps.
  • Navigation Compose: Verwaltet die In-App-Navigation zwischen zusammensetzbaren Zielen.
  • API-Integration: Ruft Fotodaten von einer entfernten Quelle ab.

🚀 Installation

Um dieses Projekt auf Ihrem lokalen Rechner zum Laufen zu bringen, befolgen Sie diese Schritte:

  1. Das Repository klonen: 
    git clone https://github.com/Software-Guardians/AndroidJetpackComposeRetrofitPhotoViewer.git
  2. In Android Studio öffnen: Navigieren Sie in das geklonte Verzeichnis und öffnen Sie das Projekt in Android Studio.
  3. Gradle-Projekt synchronisieren: Android Studio wird Sie automatisch auffordern, das Gradle-Projekt zu synchronisieren. Falls nicht, lösen Sie dies manuell über File > Sync Project with Gradle Files aus.
  4. Erstellen und Ausführen: Wählen Sie Ihren gewünschten Emulator oder Ihr physisches Gerät aus und klicken Sie in Android Studio auf die Schaltfläche "Run" (das grüne Dreieckssymbol).

💡 Verwendung

Sobald die Anwendung erfolgreich installiert und gestartet wurde:

  1. App starten: Die Anwendung startet auf dem Hauptbildschirm, der ein Raster oder eine Liste von Fotos anzeigt.
  2. Fotos ansehen: Von der konfigurierten Remote-API abgerufene Fotos füllen den Bildschirm. Sie können durch die Liste scrollen, um weitere Bilder zu entdecken.
  3. Details erkunden: Tippen Sie auf ein beliebiges Foto, um zu einer Detailansicht zu navigieren, in der Sie weitere Informationen oder Eigenschaften zu diesem spezifischen Bild sehen können.

📁 Projektstruktur

Das Projekt folgt einer modularen und sauberen Architektur, die es leicht verständlich und wartbar macht. Hier ist ein Überblick über die wichtigsten Verzeichnisse:

.
├── app/
│   ├── src/
│   │   ├── main/
│   │   │   ├── java/
│   │   │   │   └── com/emrullaheniscetinkaya/photoapplication/
│   │   │   │       ├── dependencies/    // Hilt-Anwendungssetup und Module
│   │   │   │       ├── entities/        // Datenmodelle für Fotos
│   │   │   │       ├── services/        // API-Dienstschnittstellen, Retrofit-Client und Repository
│   │   │   │       ├── screens/         // UI-Composables (MainScreenCompose, PropertiesScreen)
│   │   │   │       ├── ui/              // UI-bezogene Komponenten wie Theme, Farbe, Typ
│   │   │   │       ├── viewmodels/      // ViewModel-Klassen für UI-Logik und Daten
│   │   │   │       └── MainActivity.kt  // Haupteinstiegspunkt der Anwendung
│   │   │   └── res/                     // Android-Ressourcen (Layouts, Drawables, Werte)
│   │   └── androidTest/                 // Instrumentierte Tests
│   │   └── test/                        // Unit-Tests
│   └── build.gradle.kts                 // Modul-spezifische Gradle-Build-Datei
├── gradle/                              // Gradle Wrapper-Dateien
├── .gitignore                           // Git-Ignore-Regeln
├── build.gradle.kts                     // Projekt-spezifische Gradle-Build-Datei
├── settings.gradle.kts                  // Gradle-Einstellungen
├── gradlew                              // Gradle Wrapper-ausführbare Datei (Linux/macOS)
├── gradlew.bat                          // Gradle Wrapper-ausführbare Datei (Windows)
└── LICENSE                              // Projekt-Lizenzdatei

🤝 Beitrag

Beiträge sind willkommen! Wenn Sie Vorschläge für Verbesserungen, neue Funktionen oder Fehlerbehebungen haben, befolgen Sie bitte diese Schritte:

  1. Das Repository forken.
  2. Einen neuen Branch erstellen (git checkout -b feature/AmazingFeature).
  3. Ihre Änderungen committen (git commit -m 'Add some AmazingFeature').
  4. Auf den Branch pushen (git push origin feature/AmazingFeature).
  5. Einen Pull Request öffnen.

Bitte stellen Sie sicher, dass Ihr Code den standardmäßigen Kotlin/Android-Stilrichtlinien entspricht und entsprechende Tests enthält.

📄 Lizenz

Dieses Projekt ist unter der MIT-Lizenz lizenziert – weitere Details finden Sie in der Datei LICENSE.

✒️ Autor

Emrullah Enis Çetinkaya GitHub Profile

Date: 2025

About

No description, website, or topics provided.

Resources

Readme

License

MIT license
Activity
Custom properties

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages