# ShopKonnect © 2014-2015 - Shopper App

## Description

In ShopKonnect application we can distinguish few main sections like Offers, Merchants, Branches, Friends, Profile, Outlets. Below is the explanation of those sections, the navigation flow and other details.

### Main Activity

The Main Activity is divided into two screens - Market and Places. Both screens are divided into four sections. In Market screen we have Nearby, My Offers, Suggested and Wishlist sections. Every section has offers list.

- In Nearby section we have offers from outlets that are 10 or 25 miles away from user.
- In My Offers section we have offers assigned to the user by merchant
- In Suggested section we have offers suggested by merchant
- In Wishlist section we have offers that have been added to the wishlist by the user

In Places screen we have four other sections - Nearby, Followed, Suggested and All. Every section has merchants list.

- In Nearby section we have merchants that are 10 or 25 miles away from user.
- In Followed section we have merchants that have been added to the follow list by user.
- In Suggested section we have list of suggested merchants
- In All section we have list of all of the merchants

Offer cards and Merchant cards have sliding menu for navigation. ShopKonnect logo has search bar and dialog fragment with notifications (when user is logged in and has at least one notification). On the left we have navigation drawer with user data (avatar and e-mail) and navigation menu - Profile, Rewards, Friends list and Settings.

### Offer

  To offer details we can navigate from main activity, notification and list in merchant details. In this screen we have description, nearest place we can redeem in, address and map marker with location. We have also possibility to add this offer to wishlist.

### Outlet

  To outlet details we can navigate from offer details, other branches list, merchant details. In this screen we have an option to use external application for navigation; we have opening hours, address and distance to the outlet. We have also a list of facebook reviews from other users and rating of the outlet.

### Merchant

  To merchant details we can navigate from main activity. There we have address to nearest outlet, marker on map with the nearest outlet, navigation to program (if its active) and offers list. There is also a sliding menu for navigation. We can use to follow this merchant, go to other branches section, loyalty program. If we are logged in with facebook account, we can also like the merchant and check-in.

### Branches list

  It is a list of all of the branches for specific merchant. We can navigate to it from outlet details and sliding menu in merchant card. On the branch card we have information about distance, opening hours, where it is on the map and address. We can also call there by clicking on the phone number.

### Rewards

  When you have a reward, you can show/use it from rewards list. You can navigate there from navigation drawer. You can also transfer it to your friend from the sliding menu.

### Friends List

  You can navigate there from navigation drawer. You can add your friends with plus button which is on the right of the toolbar. You can also transfer a reward by selecting appropriate menu item.

### Loyalty Program

  If merchant has active program, you can navigate to it from sliding menu in market section (main activity) and merchant details. In this section you have description, rewards list, terms and conditions of the program and stamps list. Also from there you can transfer the reward to your friend

## Libraries (In progress...)

1. RxJava

   *This library is used to combine requests and transform api responses into final data.*

  > Link: [https://github.com/ReactiveX/RxJava](https://github.com/ReactiveX/RxJava)

2. Retrofit

  *Retrofit library is used to handle REST architecture in android app.*

  > Link: [http://square.github.io/retrofit/](http://square.github.io/retrofit/)

3. Support Libraries

  *Support libraries are used for backward compatibility with older android's versions.*

  > Link: [http://developer.android.com/tools/support-library/index.html](http://developer.android.com/tools/support-library/index.html)

4. Butterknife

  *This library is used to annotate fields for finding and casting corresponding views.*

  > Link: [http://jakewharton.github.io/butterknife/](http://jakewharton.github.io/butterknife/)

5. Picasso

  *This library is used to maintain image loading and processing in android.*

  > Link: [http://square.github.io/picasso/](http://square.github.io/picasso/)

6. Calligraphy

  *Library used to declare custom fonts in XML files.*

  > Link: [https://github.com/chrisjenx/Calligraphy](https://github.com/chrisjenx/Calligraphy)

7. Google Play Services

  *Google Play Services are required for Google Maps, GCM Services, Directions Api and so on.*

  > Link: [https://developer.android.com/google/play-services/index.html](https://developer.android.com/google/play-services/index.html)

8. JodaTime

  *This library provides many features for time and date classes.*

  > Link: [http://www.joda.org/joda-time/](http://www.joda.org/joda-time/)

9. Active Android

  *ORM for android.*

  > Link: [http://www.activeandroid.com/](http://www.activeandroid.com/)

10. Event Bus

  *EventBus is publish/subscribe event bus optimized for Android.*

  > Link: [https://github.com/greenrobot/EventBus](https://github.com/greenrobot/EventBus)

11. RetroLambda

  *It is a backport of lambda expressions in Java 5,6, and 7.*

  > Link: [https://github.com/orfjackal/retrolambda](https://github.com/orfjackal/retrolambda)

12. Material Edit Text

  *Library that provides edit texts in new Material Design style.*

  > Link:[https://github.com/rengwuxian/MaterialEditText](https://github.com/rengwuxian/MaterialEditText)

13. Sliding Up Panel

  *Library that provides dragging sliding up panel.*

  > Link: [https://github.com/umano/AndroidSlidingUpPanel](https://github.com/umano/AndroidSlidingUpPanel)


14. OkHttp

  *Second library used to handle REST architecture in ShopKonnect. Especially for XPERIA phones*

  > Link: [https://github.com/square/okhttp](https://github.com/square/okhttp)

15. Timber

  *Library used for* **Log** *class improvement.*

  > Link: [https://github.com/JakeWharton/timber](https://github.com/JakeWharton/timber)

16. Reactive Location

  *Small library that wraps Google Play Services API in brilliant RxJava Observables reducing boilerplate to minimum.*

  > Link: [https://github.com/mcharmas/Android-ReactiveLocation](https://github.com/mcharmas/Android-ReactiveLocation)

17. ACRA

  *ACRA is a library enabling Android Application to automatically post their crash reports to a GoogleDoc form*

  > Link: [http://www.acra.ch/](http://www.acra.ch/)

18. Expendable Text View

  *Library that allows developer to create text view that collapse/expand.*

  > Link: [https://github.com/Manabu-GT/ExpandableTextView](https://github.com/Manabu-GT/ExpandableTextView)

19. ASNE

  *With this library we can manage social networks api's, such like Facebook, Google Plus, LinkedIn etc.*

  > Link: [https://github.com/gorbin/ASNE](https://github.com/gorbin/ASNE)

20. Smooth Progress Bar

  *This library allows developer to create progress bar in material design style*

  > Link: [https://github.com/castorflex/SmoothProgressBar](https://github.com/castorflex/SmoothProgressBar)

21. QRCodeReaderView

  *Library for QR Code detection in portrait mode in android.*

  > Link: [https://github.com/dlazaro66/QRCodeReaderView](https://github.com/dlazaro66/QRCodeReaderView)

## Project Structure (For v2.0)

  Below is an explanation of the project structure. The project is divided into main sections - data, user interface and utilities.

### Data Section

  In this section we can find classes that handle REST architecture (Retrofit), events (EventBus) and preferences (SharedPreferences). There is also package with POJO model objects, which are received from api responses.

#### API

  As mentioned above, we are using Retrofit and OkHttp to handle REST architecture. We divided it into ApiAdapter, ApiManager and ApiService.

- ApiAdapter class wraps RestAdapter and adds all of the headers and other features needed to connect successfully with server.
- ApiManager is a class where we have all of the RxJava methods that returns Observables with API responses.
- ApiService is an interface with Retrofit methods (plain REST methods).

#### Events

  In this package we have events that are populated with EventBus. We specified NotificationEvent class for notifications and CommonStatusEvent for handling errors (offline mode and problems with server connection).

#### Model

  This is place where POJO's are.

#### Preferences

  In this package we have UserPreferences class and LocationPreferences class. UserPreference is used for saving user data (after successfully connected to server and created a session). LocationPreferences is used to save last known location.

### User Interface

  In this section we can find all of the user interface classes, such as activities, fragments, adapters, controllers.

#### Default Architecture

 Most of the fragments (except Login/Registration) are bind to its own activity. We make api calls in fragments. If there are not Recycle Views and other adapters, the views are set also in fragments. Some of them (Reset Password, Change Password, Profile and Settings) have also been developed with MVP pattern. In those fragments, all of the logic is done in Presenters.

 All of the activities extends BaseActivity; all of the fragments extends BaseFragment. This allows us to easily implement EventBus and QRCodeSlidingPanel for example.

### Utils Section

  In this section we can find utilities that are created to handle common android operations and omit boilerplate code. For example there is a DisplayMetricsUtils class that converts dp to px / px to dp or UnitConverter class which converts kilometers to miles / miles to kilometers and returns proper units that were chosen by the user.