Giter Club home page Giter Club logo

bcg's Introduction

BCG Application CircleCI Build Status

This repository holds the source code of the BCG Android Application. This application was created by Mohsen Mirhoseini Argi, as part of the technical assessment by the BCG Digital Ventures team.


What is this repository for?

  • BCG Application
  •   Version:  1.0
    
  • Last Update: Sun Jan 8, 2017

Login Screenshot Profile Screenshot


Development Tools

  • Android Studio v2.2.3
  • gradle-plugin v2.2.3
  • Android SDK Build Tools v25.0.0
  • MinSdkVersion 9
  • CompileSDKVersion 25
  • Retrolambda v3.3.1

Dependencies

  • Android Support Tools (recyclerView, cardView, vector, design, palette,... ) v25.1.0
  • Retrofit v2.1.0
  • OkHttp v3.4.1
  • Dagger v2.8
  • RxJava v1.2.3
  • RxAndroid v1.2.1
  • ButterKnife v8.4.0
  • Timber v4.3.1
  • Picasso v2.5.2
  • AutoValue v1.2
  • AndroidUtils v1.0.7
  • AppSettings v1.0.2
  • jUnit v4.12
  • Android Support Test v0.5
  • Mockito v1.10.19
  • Robolectric v3.1.1
  • Espresso v2.2.2

Important Notes

The application has two Activities, Main and Login. The MainActivity is consist of one Fragment, ProfileFragment, which is responsible for presenting User profile info including email and avatar.

All activity lifecycle and network behaviours are implemented, and according to device size and network situation user get a good UI and UX. If no internet connection or network error, a Snackbar pops up and ask user to turn on network connection or retry.

Some simple Test Cases was designed to test application UI functionality and core classes using jUnit and AndroidUnitTest.

The task contains no backend URL service, so I developed a simple static backend according to Task information on my own server.

Application Structure

The Application implemented and structured bases on the MVP pattern best practice, contributed by Antonio Leiva.

Whole application functionality is implemented in Core-Lib module using pure Java. The App module contain all codes required for Android Application to load on Android OS, which can be replace by any other interface (e.g. console app or web app). You can read more about this development method in this article published by me on hackernoon.com

The view (MainActivity, LoginActivity, ...), contain their own presenters and implement View interfaces and the only thing that the view will do is calling a method from the presenter every time there is an interface action.

The presenter (LoginPresenter, ProfilePresenter), is responsible to act as the middle man between view and model. It retrieves data from the Model and returns it formatted to the view. It also decides what happens when user interact with the view.

The models (UserInteractor), would only be the gateway to the service domain layer or business logic. In this case it provide the data needed to be displayed in the view from Network.

The networking and API call are managed by Retrofit and OkHttp as its httpclient, contributed by Square. It also shows decent logs while application is running in Debug mode.

Layers communications are managed by RxJava & RxAndroid contributed by ReactiveX.

Dependency Injections are being managed by Dagger created by Square and now maintained by Google.

Model are Generated immutable using AutoValue contributed by Google.

Diagram

Some minor Android common functions are managed using AndroidUtils library, developed and published on jCenter by myself.

Caching user data on disk are managed using AppSettings library, developed and published on jCenter by myself.

Whole projects Dependencies are placed in libraries.gradle to avoid version conflicts and redundant in different modules.

Used new SupportVector library in some icons cases for a better UI.

Used new DataBinding library contributed by Google in ProfileFragment for faster development, and added CustomBindingAdapter to handle downloading, caching and also cropping user avatar into circle using Picasso library, which also use google Palette support library as a helper class to extract prominent colors from image and making a related background for a better UI/UX.

The Android Log system is replaced with Timber contributed by Jake Wharton, which avoid logging in release version.

Sample test cases are implemented by mockito, espresso, robolectric and mocking dagger separately in Core-Lib and App modules.

Finally, used circleci and travis ci as Continues Integration services which are bind with project Github repo.

bcg's People

Contributors

mohsenoid avatar

Stargazers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.