segunfrancis/Card-Info-Finder

Android app that displays card information after entering part or all of the card numbers. Built using android MVVM pattern

Card-Info-Finder

Card Info Finder app that displays card information after entering part or all of the card numbers. Built using android MVVM pattern

It is written 100% in Kotlin with unit, integrated and UI tests.🙂

Languages, libraries and tools used

• Kotlin
• Android Support Libraries
• Coroutine
• Flow
• Hilt
• Card-io
• Retrofit
• OkHttp
• Gson
• Timber
• Lottie
• JUnit
• Espresso
• Robolectric

Requirements

• JDK 1.8
• Android SDK
• Android 11 (API 30)
• Latest Android SDK Tools and build tools.

Installation

• To run this code, clone this repository using this command git clone https://github.com/segunfrancis/Card-Info-Finder.git
• Import into android studio
• Build the project and run on an android device or emulator

Architecture

The architecture of the project follows the principles of Clean Architecture and MVVM. Here's how the project implements it:

The app when run will displaya an interface that gives the user 2 options of how they want to input their card number.

This architecture is used in order to maintain clean coding and adhere to the SOLID principles of coding. Let's look at each of the architecture layers and the role each one plays :)

Presentation layer

This layer contains the views(activity and fragments) and their ViewModel classes. The ViewModel receives its data from the use case layer and then supplies the views.

Use case layer

This layer presents each individual action of the app.

Domain layer

The domain layer contains the data transfer objects for the entire app.

Data layer

The Data layer is our access point to external data source and is used to fetch data from multiple sources (examples are cache and network). In this case, it gets data from the remote source only.

Screens

Reference

• Card scan animation - Lottie Animation

• Card payment animation - Lottie Animation

Author

• Segun Francis

LICENSE

MIT License

Copyright (c) 2021 Segun Francis

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.