Functionality

The app's functionality includes:

Register with user's data & save into local database
Login with username, password
After successful login takes the user to the home page.
Login session expires if a user is in the background for more than 10 seconds or foreground for more than 30 seconds.
The app uses a custom button component, which can be used to configure different custom properties like image, sub-title, color, ripple, shape, border, corner radius, etc.
User can log out from the session.

RegisterFragment

Initial screen - when the user first opens the app. It shows text fields (full name, username, password) for users to fill up and register in the app. There are rules set up for username & password. a) Username must be greater than 5 characters. b) Password must be greater than 3 characters. c) Password must contain 1 digit. d) Password must contain 1 lowercase character. e) Password must contain 1 uppercase character.

LoginFragment

This fragment displays when the user successfully completed the registration. The login fragment uses username & password validation for the user. It checks the values already stored in the database against the entered values. If the user is already registered, the app will navigate the user to the login fragment.

HomeFragment

Displays after successful login. The home fragment uses a lifecycle observer to track user's time spent on the foreground or background of the app. Users can also log out from home fragment.

Building

You can open the project in Android studio and press run. Android Studio version used to build the project: 4.2.2

Installation

While installing the .apk - please click install anyway, if the google play protect warning shows an unverified publisher.

Libraries

Android Support Library

Android Architecture Components

Android Data Binding

Coroutine for database operation

Room for local database

Android navigation components

LiveData, Lifecycle components.

Mockito, Espresso, Junit for testing

Testing

The app uses both unit & instrumentation tests.

RegisterViewModelTest.kt - Unit test for the registration rules.

UserDataBaseDaoTest.kt - Test class for testing the database access objects for user entity.

InstrumentationTest.kt - Instrumentation test using espresso. The test runs from the beginning of the app process & verifies the navigation through different actions. This test should be run on first run of the app.

Custom Button

The app has a custom module called Custom Button, which is used across the main application.

Custom Button has the following properties:

a) Button title - show/hide/change color/size
b) Button subtitle - show/hide/change color/size
c) Button image - show/hide/tint color/Image size
d) Button ripple - color
e) Button background color
f) Button shape (rectange, circle, square, oval)
g) Button border - width/color
h) Button corner - radius

These attributes can be configured from layouts.xml

For example:

<com.dev.custombutton.CustomButton
android:id="@+id/logoutBtn"
android:layout_width="250dp"
android:layout_height="50dp"
android:layout_marginBottom="50dp"
android:onClick="@{()->viewModel.logoutUser()}"
app:btn_backgroundColor="@color/light_blue"
app:btn_borderColor="@color/border_color"
app:btn_borderWidth="1dp"
app:btn_cornerRadius="10dp"
app:btn_image="@drawable/logout_icon"
app:btn_imageSize="40dp"
app:btn_imageTint="@color/white"
app:btn_imageVisible="true"
app:btn_rippleColor="@color/purple_700"
app:btn_subtitle="@string/end_session"
app:btn_subtitleColor="@color/white"
app:btn_title="@string/logout"
app:btn_titleColor="@color/white"/>

The attributes can also be configured from themes.xml