Wallsyfy is an Android application that allows users to explore and interact with a wide variety of high-quality wallpapers. Users can browse through the collection, set wallpapers, and download them with ease. The app is built using Jetpack Compose for the user interface (UI) and follows the MVVM architecture for a clean, maintainable, and testable codebase.
- Wallpaper Browsing: Explore a wide range of high-quality wallpapers.
- Set Wallpaper: Set any wallpaper directly to your device from within the app.
- Download Wallpaper: Download wallpapers to your device.
- Jetpack Compose UI: The UI is built using Jetpack Compose, a modern, declarative framework for building Android UIs.
- MVVM Architecture: The app follows the Model-View-ViewModel (MVVM) architecture for better separation of concerns and maintainability.
- Koin for Dependency Injection: Uses Koin to manage dependencies, making the code more modular, testable, and easier to maintain.
- Coroutines for Asynchronous Operations: All network operations are performed asynchronously using Coroutines.
- No User Authentication: No sign-in or account creation required, allowing for a smooth, frictionless user experience.
- Favorites (Planned): Future feature allowing users to save and manage their favorite wallpapers.
- Kotlin: The programming language used to build the app.
- Jetpack Compose: A modern UI toolkit for building native Android UIs.
- MVVM Architecture: A pattern that helps in separating concerns in the codebase.
- Koin: A lightweight dependency injection framework for Kotlin.
- Ktor: A framework used for making network calls.
- Coil: An image loading library used for efficient image loading and caching.
- Coroutines: For managing background threads and asynchronous operations.
Follow the steps below to run the project locally:
-
Clone the repository:
git clone https://github.com/remziakgoz/Wallsyfy.git
-
Open the project in Android Studio.
-
Wait for the Gradle files to sync.
-
Run the app on a physical device or emulator.
Upon opening the app, you will be greeted with a list of wallpapers. You can:
- Browse through the collection.
- Tap on any wallpaper to view it in full size.
- Set the wallpaper directly to your device by tapping the "Set Wallpaper" button.
- Download the wallpaper to your device by tapping the "Download" button.
- Favorites System: Users will be able to favorite wallpapers to easily access them later.
- Categories: Ability to filter wallpapers by categories (e.g., nature, abstract, technology).
The project includes unit and UI tests to ensure the application works as expected. The following tests are available:
- WallpaperScreenTest: Verifies that wallpapers are loaded and displayed correctly.
- WallpaperSetTest: Ensures that setting a wallpaper works as expected.
- WallpaperDownloadTest: Verifies that the wallpaper can be downloaded successfully.
- NavigationTest: Ensures smooth navigation between different screens of the app.
- WallpaperViewModelTest: Tests the business logic of handling wallpaper data.
To run the tests:
-
In Android Studio, click on Run and select Test.
-
Alternatively, you can run the tests from the terminal:
./gradlew test
If you'd like to contribute to the project, follow these steps:
- Fork the repository.
- Create a new feature branch (
git checkout -b feature/your-feature-name). - Commit your changes (
git commit -m 'Add new feature'). - Push to your branch (
git push origin feature/your-feature-name). - Open a pull request with a description of what your changes do.
This project is licensed under the MIT License - see the LICENSE file for details.
- Developed by Remzi Akgöz.
- Showcases modern Android development practices using Jetpack Compose, Koin, and MVVM architecture.
- Aims to provide a simple yet powerful experience for users looking for high-quality wallpapers.
Enjoy exploring and setting beautiful wallpapers with Wallsyfy!