This sample app enables users to search for photos on the Flickr platform. Clicking on a search result item from the infinitely scrolling paginated list displays the image on a full screen, which can be viewed in Portrait and Landscape mode. The app also saves the photos data retrieved from Flickr in a local database, which is used as a fallback during offline mode.
https://www.flickr.com/services/api/flickr.photos.search.html
Apart from the Android SDK & other standard libraries, few other open source libraries were used in the project. Here is the list with their corresponding purposes:
- Dagger - Dependency Injection.
- RxJava - Asynchronous & Event based programming.
- OkHttp - Networking.
- Retrofit - Networking.
- Gson - Serialization/De-Serialization.
- Picasso - Image loading.
- Butterknife - View binding.
- Timber - Logging.
- Room - Local database.
- ReactiveNetwork - Network Monitoring.
- Junit - Unit testing.
- AssertJ - Assertions.
- Mockito - Android Instrumentation tests.
- Espresso - Instrumentation tests.
I have used Android Studio 4.0.2 to develop this project. Tried to stick to tools/libraries that I am familiar with to make the best use of time. Steps to build/deploy the app:
- Clone the master branch from the repository.
- Before opening the project on your Android Studio, please ensure that Gradle 6.1.1 is installed on your machine.
- Open the 'myflickr' project in your Android Studio.
- Do a 'Build' -> 'Clean'. If the Clean command executes successfully, you should be ready to deploy the app to a connected device or your emulator instance.
- The 'app' module should be auto-selected in the deployment configuration drop-down. Hit the Run app button to deploy and if all goes well, the 'MyFlickr' app should be ready to test on your target device.
Added few tests for the different types of test we would want to expand on. There are some unit tests and instrumentation tests as well. Given the scope of this exercise, I have limited the amount of time spent on tests.
Tests can be executed by running the gradle task: 'test'.
The Flickr API keys are specified in the 'myflickr.properties' file.
I use the PAW tool to test network request/responses and I have added the PAW config file for the Venues API in the 'resources' directory.