README.md

Android App For TW's Coding Exercise

The Android Stock Watcher app is an implementation of TW's Coding Exercise requirements. The app allows a user to create stock watchlists and manage them.

Build Requirements

1. Android Studio 4.0
2. Gradle 6.1.1
3. Android Gradle Plugin 4.0.0
4. OpenJDK 1.8.0 update 242
5. Android SDK 29
6. Android SDK Build Tools 29.0.3
7. Kotlin 1.3.72

Building Application

1. The app consumes IEX's API and needs an IEX authentication token to work. The token can be added to a local.properties as follows:

api.token="pk_1234abctoken"

Or it can be passed as a property when building from the command line, as follows:

./gradlew assembleDebug -Papi.token="pk_my_token"

2. From the command line simply run:

./gradlew assemble -Papi.token="your token here"

Lint/Kotlin Style Check

Run kotlin lint:

./gradlew ktlint

Auto format kotlin style issue:

./gradlew ktlintFormat

Tests

Unit tests:

./gradlew test

Android instrumentation tests:

./gradlew connectedCheck

Architecture

App uses the VIPER architectural pattern, relies on RxJava/Kotlin for asynchronous tasks, and uses Dagger for dependency injection.