jumaallan/AndelaCryptoApp

View on GitHub
README.md

Summary

Maintainability
Test Coverage
# Andela Track Challenge [![Build Status](https://circleci.com/gh/jumaallan/AndelaCryptoApp/tree/master.svg?style=shield)](https://circleci.com/gh/jumaallan/AndelaCryptoApp/tree/master)   [![Maintainability](https://api.codeclimate.com/v1/badges/43a1639bce2750ec37b3/maintainability)](https://codeclimate.com/github/jumaallan/AndelaCryptoApp/maintainability)  [![Test Coverage](https://api.codeclimate.com/v1/badges/43a1639bce2750ec37b3/test_coverage)](https://codeclimate.com/github/jumaallan/AndelaCryptoApp/test_coverage)

My Andela Learning Community 2.0 Android Intermediate Assessment Track Challenge.
> The final apk can be download here : https://github.com/jumadeveloper/AndelaTrackChallenge/blob/master/andelatrackchallenge.apk

## Prerequisites
You will need the following to run this project:
1. A laptop or desktop machine with internet access
2. Android Studio 3.0 Preview or later

## Setting Up
* Clone the Repository from Github
* Open the project folder using Android Studio IDE

### Splash Screen
The user will be presented with a splash screen first time they use the app. This helps them understand how the app is supposed to work using visual aids.

<img src="https://github.com/jumadeveloper/AndelaTrackChallenge/blob/master/screenshots/Screenshot_2017-11-04-23-06-12.png" width="280"/>  <img src="https://github.com/jumadeveloper/AndelaTrackChallenge/blob/master/screenshots/Screenshot_2017-11-05-00-14-57.png" width="280"/>  <img src="https://github.com/jumadeveloper/AndelaTrackChallenge/blob/master/screenshots/Screenshot_2017-11-05-00-15-00.png" width="280"/>

### Login Page
The user proceeds to the Login Page, where they need to authenticate by using either Google or Facebook.

<img src="https://github.com/jumadeveloper/AndelaTrackChallenge/blob/master/screenshots/Screenshot_2017-11-04-23-06-17.png" width="280"/> <img src="https://github.com/jumadeveloper/AndelaTrackChallenge/blob/master/screenshots/Screenshot_2017-11-04-23-06-34.png" width="280"/> <img src="https://github.com/jumadeveloper/AndelaTrackChallenge/blob/master/screenshots/Screenshot_2017-11-04-23-31-39.png" width="280"/>

### Home Page
After being authenticated, the use is redirected to the Home Page, which is the Main Activity in our application.
The application has a Dark and a Light theme, which appear as shown below.

<img src="https://github.com/jumadeveloper/AndelaTrackChallenge/blob/master/screenshots/Screenshot_2017-11-04-23-32-18.png" width="425"/>  <img src="https://github.com/jumadeveloper/AndelaTrackChallenge/blob/master/screenshots/Screenshot_2017-11-04-23-31-54.png" width="425"/>

The user is prompted to create a new Card using the FAB, on the bottom right corner. This is how it appears on different themes.

<img src="https://github.com/jumadeveloper/AndelaTrackChallenge/blob/master/screenshots/Screenshot_2017-11-04-23-32-24.png" width="425"/>  <img src="https://github.com/jumadeveloper/AndelaTrackChallenge/blob/master/screenshots/Screenshot_2017-11-04-23-32-36.png" width="425"/>

After adding countries, they appear as shown below:

<img src="https://github.com/jumadeveloper/AndelaTrackChallenge/blob/master/screenshots/Screenshot_2017-11-04-23-33-32.png" width="425"/>  <img src="https://github.com/jumadeveloper/AndelaTrackChallenge/blob/master/screenshots/Screenshot_2017-11-04-23-36-16.png" width="425"/>

User's can change themes easily. They can also generate colors from County's flags using the Palette. This is EXPERIMENTAL and might not work perfectly well!

<img src="https://github.com/jumadeveloper/AndelaTrackChallenge/blob/master/screenshots/Screenshot_2017-11-04-23-32-43.png" width="425"/>  <img src="https://github.com/jumadeveloper/AndelaTrackChallenge/blob/master/screenshots/Screenshot_2017-11-04-23-33-22.png" width="425"/>

The users can also modify cards location by pinning them to the top, or unpinning them and by deleting them also!

<img src="https://github.com/jumadeveloper/AndelaTrackChallenge/blob/master/screenshots/Screenshot_2017-11-04-23-36-38.png" width="425"/>  <img src="https://github.com/jumadeveloper/AndelaTrackChallenge/blob/master/screenshots/Screenshot_2017-11-04-23-36-44.png" width="425"/>

The users can also modify cards location by pinning them to the top, or unpinning them and by deleting them also!

<img src="https://github.com/jumadeveloper/AndelaTrackChallenge/blob/master/screenshots/Screenshot_2017-11-04-23-36-38.png" width="425"/>  <img src="https://github.com/jumadeveloper/AndelaTrackChallenge/blob/master/screenshots/Screenshot_2017-11-04-23-36-44.png" width="425"/>

The app updates real time currency rates, and shows if the currency is gaining or loosing on the Home Screen, on each card the user has created!

<img src="https://github.com/jumadeveloper/AndelaTrackChallenge/blob/master/screenshots/Screenshot_2017-11-04-23-44-22.png" width="425"/>

As shown in the above image, you can see the gain and the loss using the red and green drawables that make it easy to distinguish how the currency is comparing to the crypto currencies in real time!

### Currency Conversion
The users can easily convert currencies by selecting the amount. They can switch between Bitcoin and Ethereum easily. The app also shows history for the last 5 days! Bonus!

<img src="https://github.com/jumadeveloper/AndelaTrackChallenge/blob/master/screenshots/Screenshot_2017-11-04-23-34-21.png" width="425"/>  <img src="https://github.com/jumadeveloper/AndelaTrackChallenge/blob/master/screenshots/Screenshot_2017-11-04-23-34-26.png" width="425"/>

<img src="https://github.com/jumadeveloper/AndelaTrackChallenge/blob/master/screenshots/Screenshot_2017-11-04-23-36-23.png" width="425"/>  <img src="https://github.com/jumadeveloper/AndelaTrackChallenge/blob/master/screenshots/Screenshot_2017-11-04-23-36-29.png" width="425"/>

<img src="https://github.com/jumadeveloper/AndelaTrackChallenge/blob/master/screenshots/Screenshot_2017-11-04-23-34-53.png" width="425"/>  <img src="https://github.com/jumadeveloper/AndelaTrackChallenge/blob/master/screenshots/Screenshot_2017-11-04-23-35-54.png" width="425"/>

### Sign Out
The users can leave the app by signing out. This clears their user data as well as the app's data and customizations, if any!

<img src="https://github.com/jumadeveloper/AndelaTrackChallenge/blob/master/screenshots/Screenshot_2017-11-04-23-37-06.png" width="425"/>  <img src="https://github.com/jumadeveloper/AndelaTrackChallenge/blob/master/screenshots/Screenshot_2017-11-04-23-37-15.png" width="425"/>

## Some Notable Issues
* Sign Out
* Minor issues with pre-lollipop devices