julioz / instantsonar

Instant Sonar

Sample app for the Instant Apps SDK

This is a sample project to showcase the basic functionality of the Instant Apps SDK on Android. Check out more information about it on my blogpost.

How to build

This project uses SoundCloud's public API to fetch information around artists and tracks on their database. In order to be able to build it, you'll have to include a local.properties file on the project's root folder which contains the following content:

sdk.dir=<PATH_TO_SDK>
soundcloudClientId=<SOUNDCLOUD_CLIENT_ID_STRING>
userId=<ARTIST_IDENTIFIER_ON_SOUNDCLOUD_BASE>

After defining the project's properties, running either the gradlew create task or the fully named gradlew :sonaria:assembleDebug will assemble the Instant App zip to be installed on devices. You can also install it using Android Studio 3.0 and above support by importing the project.

Project structure

This project is composed by a number of Android modules, which are all bundled in the final zip file that represents the Instant App:

• sonarartists: Artist feature. Will respond to the URL https://instantsonar.com/artist which will launch a list of the tracks for the artist defined by the userId property on the .properties file.
• sonartracks: Track feature. Will respond to the URLs like https://instantsonar.com/track/<track_id> and will launch an Activity that presents the details of the track defined by the track_id query param.
• sonarbase: Base feature. Contains shared functionality across the other features, shared Android resources, as well as the main AndroidManifest file that determines the permissions and the Instant App configuration.
• sonaria: Builder module for the Instant App zip generation.

Testing

The project contains (very simple) tests, as a proof-of-concept that the usual testing techniques still work in a multi-module environment. In order to run them, simply execute the gradlew test task.