Music Wiki

MusicWiki is an unofficial Last.fm app that contains information about different music genres, the albums, artists and tracks listed under the genre.

How to build the project?

Get your api key from lastFm and put that key in gradle.properties and build the project, and you are good to go.

Build the project in studio or write following commands Open terminal and type the below command to generate debug build below are commands for Linux and Mac OS users

./gradlew assembleDebug

To build and install the app in running emulator

./gradlew installDebug

Or Just download the apk file in from here

How its being developed?:

All the android new Best Practises have been implemented:

• Android navigational Component for navigation between fragment and achieving a single activity based application
• MVVM architecture with deferring all complexities of UI to viewModel and repository.
• Using Dagger for dependency Injection
• Simplicity and easy design of the app (Inspired by Indicative UI provided )
• Android View Binding to avoid monotonous findViewById call and run-time exceptions and crashes.

Some Screenshots:

Features

The application has following features implemented

• Users can explore various genres of songs
• Explore artists, albums, tracks
• Know their artist more closely
• Open tracks in custom chrome tabs
• Clean and simple UI
• Modularized App with dagger

Architecture followed

Expect Room (Local storage) the architecture of the app is inspired by above diagram

Libraries Used

• Retrofit and OkHttp
• Glide for Image
• Timber for Logging
• Dagger for dependency Injection
• JUnit for Unit testing
• Truth for Testing assertion

Decisions

1. For a testable android application we must have class speration of concern and thats is the reason why application follows complete MVVM architecture with View, ViewModels ,Repository and model class.

2. Decision of not using rx-java as it had not much use-case to server in present app, using rx-java would have been much beneficial in some core problem like search functionality and profile details call for each person and power it gives with Zip, flatMap ,debounce, delay operators and other operators. Rx-java can be much useful when we want to make a better pub-sub communication between android components. But for this application live-data solved much of the use-cases, and hence rx-java was not missed much!

3. Server sends star like image for artist profile's avatar and for tracks's cover, and because of this I created a rule based avatar for artist's avatar it can be found in CommonUIUtils.java

4. Tried to resuse the code as much as possible like Shared viewModel between tab fragments, and common adapter for 3 recyclerviews

5. Decision of handling the api-errors which occurs in the app usage, following are the screens that shows some of the illustrations of error handling

6. Singleton design pattern and OOPs concepts are demonstrated in the source code.

Assumptions

• Assumption that data would always be non-null from server, although I have surrounded code blocks with try and catch block (can be found in ArtistDetailsFrag and AlbumDetailsFrag), and that would prevent the application from crash and silently it would fail.

• Assumption that apiKey would be needed in each and every REST call, thus apiKey is injected by retrofit Interceptor on each api call.

Testing

• Unit tests for CommonUIUtils and Timely greeting can be found in test directory
• Unit Tests for viewModels (HomeScreenViewModel, can be found in test directory) using test-doubles for Repository and checking its integration with repository

Todo

• Full end to end testing with mock data
• Convert to kotlin
• a generic response wrapper for handling data coming from server