Giter VIP home page Giter VIP logo

github-app's Introduction

Github App

An android app built using Kotlin that consumes the Github API to search for Github profiles and more information on the user. It has been built following Clean Architecture Principles, MVVM Architecture/Pattern and Modern Jetpack components.

Architecture (Clean Architecture).

Clean Architecture combines a group of practices that produce systems with the following characteristics:

  • Testable.
  • UI-independent (the UI can easily be changed without changing the system).
  • Independent of databases, frameworks, external agencies, and libraries.

The following scheme presents the architecture from the UI to the backend or database:

Clean Architecture Diagram

As you can see in the image, an Android application with Clean Architecture gathers the layers into three modules:

  1. Presentation - presents data to a screen and handle user interactions.

    • Components:
      • Activities/ Fragments
      • ViewModels
  2. Domain - which contains business logic

    • Components:
      • Models (Entities)
      • UseCases
      • Repositories Implementation
  3. Data - which manages application data eg. retrieve data from the network, manage data cache.

    • Components:
      • Local data sources
      • Remote data sources
      • Repositories Interfaces

Testing

Local Database

To test the deletion, insertion and getting of user profile and repository

  • Clean Architecture Diagram

UseCases

To test the domain's use-cases and repositories and if they make the right call

  • Clean Architecture Diagram

ViewModels

To test the logic of the app

  • Clean Architecture Diagram

Github API and Fragments

This integration test was done under an Android 11 version device Did some integration tests to test the Github API is called successfully Did some integration test to test if the search input layout is shown and the recyclerview holding the list of repositories is shown. Also if the search button is is clickable

  • Clean Architecture Diagram

ScreenShots

โ€ƒ

github-app's People

Contributors

breens-mbaka 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.