Skip to content

An android app that implements 3 Sign In UI Designs. Email and password, 4 digit pin and fingerprint auth

Notifications You must be signed in to change notification settings

katungi/app_sign_in

 
 

Repository files navigation

app sign in

Nearly every android application has it, A sign in screen. Whether it's asking for an email or password, or a 4 digit pin. User Authentication is everywhere. And thats where app sign in library comes in. This is an Android Library that allows a developer to seamlessly integrate a functioning sign in module into their already existing android application.

Email Password Sign In Pin Sign In
Biometric Sign In

Getting Started

This module is designed to be as seamless as possible and should work as a plug and play to your existing android application requiring minimal modification.

How it Works

The library uses a builder design pattern that allows you to specify which of the three sign in options you would like to add to your android project The benefit is that is allows you to state any additional sign in options your application can support. Thus making your user feel limitless.

Prerequisites

What things you need to install the software and how to install them

Android Studio

A working Android Project

Minimum sdk used :- 16

Installing

Use the following steps to get up and running as fast as possible and get back to building cool content.

Gradle

//on your project wide build.gradle file, add the maven repo link

allprojects {
		repositories {
			...
			maven { url 'https://jitpack.io' }
		}
	}

Then next step is to add the library dependency on your app build.grade file

//on your app build.gradle file, add the sign in ui

dependencies {
	        implementation 'com.github.Jackwitwicky:app_sign_in:Tag'
	}

Customization

To actually use the library. Add the following piece of code in your calling activity

SignInUI.Builder(this)
                .setSignInType(SignInUI.EMAIL_PASSWORD_FORM)
                .build()

That's it! That is all you need to display a sign in screen that prompts the user for their email and password. The library will automatically handle any form validations

However the library offers multiple configurations you can use setup authentication properly

                .setPinSignInEnabled(true) - This is used when creating email or fingerprint and would like to also offer the pin 
                .setFingerprintSignInEnabled(true) - This is used when creating email or pin and would like to also offer the fingerprint
                .setPasswordLength(6) - This is used to specifiy the validation requirements for the email passsowrd page
                .setTitle("Logger")
                .setSubtitle("The best log tracking app")

NB

The builder class expects a sign_in _type parameter to be passed as a minimum. Attempting to build an SignInUi without having specified the sign_in_type results in a Illegal State Exception

Built With

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Author

Jack Kiarie - Initial work - Other Works Daniel Katungi - Assisted work - Other Works

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

About

An android app that implements 3 Sign In UI Designs. Email and password, 4 digit pin and fingerprint auth

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Java 58.9%
  • Kotlin 41.1%