PurrfectPics is your ultimate companion for discovering, customizing, and sharing adorable cat images on Android. With a wide range of features, PurrfectPics brings joy to every cat lover's heart.
- Discover: Explore a vast collection of random cat images sourced from the web.
- Share: Share delightful cat images with friends, family, and fellow cat enthusiasts with just a tap.
- Save Favorites: Save your favorite cat images to easily revisit them later and create your personalized collection.
- UI Components: AndroidX Core KTX | Material Components for Android | Compose UI
- Compose UI: Compose UI
- Testing: JUnit | MockK | Turbine
- Dependency Injection: Hilt
- Coroutines: Kotlin Coroutines
- DataStore Proto: DataStore Proto
- Navigation: Navigation Compose | Hilt Navigation Compose
- Material Design: Material3 Material Components for Android
- Networking: Retrofit
- Image Loading: Coil
| Splashscreen | Home - Featured and popular items | Popular paginated items | Your favorites cats | Detail image (share and favorite button) | Detail image with zoomable elements |
- FREE Cat APIs used in this version: Cataas and Pexels. In particular, Pexels API is rate-limited, in case of errors for this, a new API key will be necessary to be generated.
- Localdata persistence of favorite cats only. Responses from API are not cached because these are dynamic and frequently updated data. On the other hand, Coil image lib does use disk and memory cache to smooth image loading.
- KtfmtFormat plugin applied for code formatting.
- There is a known issue with the splash screen not showing on Android 12. A temporary solution is to open the app from the app tray, as indicated here)
To get started with PurrfectPics, follow these steps:
- Clone the repository to your local
machine:
git clone [email protected]:manununhez/purrfect-pics.git - Open the project in Android Studio.
- Build and run the app on your device or emulator.
- Main Branch: The primary branch of the project, reflecting the latest stable release.
- Feature Branches: Used for developing new features. Branch names should be descriptive of the feature being developed.
- Epic Branches: Used for grouping related features or significant enhancements. Branch names should reflect the overarching theme of the epic.
- Release Branches: Used for preparing releases. Branch names should follow the
pattern
release/v<MAJOR>/<MAJOR>.<MINOR>.<PATCH>.
We welcome contributions from the open-source community to help improve PurrfectPics. Whether you're a developer, designer, or cat lover with ideas to share, we'd love to have you onboard! Here are some ways you can contribute:
- Submit bug reports or feature requests via GitHub issues.
- Fork the repository, make changes, and submit pull requests for review.
- Help improve documentation, UI/UX design, or test coverage.
PurrfectPics is licensed under the MIT License.
PurrfectPics is developed and maintained by Manuel Nuñez. For inquiries, please contact [[email protected]].